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')
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
803
self._clear_debug_flags()
804
TestCase._active_threads = threading.activeCount()
805
self.addCleanup(self._check_leaked_threads)
810
pdb.Pdb().set_trace(sys._getframe().f_back)
812
def _check_leaked_threads(self):
813
active = threading.activeCount()
814
leaked_threads = active - TestCase._active_threads
815
TestCase._active_threads = active
817
TestCase._leaking_threads_tests += 1
818
if TestCase._first_thread_leaker_id is None:
819
TestCase._first_thread_leaker_id = self.id()
821
def _clear_debug_flags(self):
822
"""Prevent externally set debug flags affecting tests.
824
Tests that want to use debug flags can just set them in the
825
debug_flags set during setup/teardown.
827
self._preserved_debug_flags = set(debug.debug_flags)
828
if 'allow_debug' not in selftest_debug_flags:
829
debug.debug_flags.clear()
830
self.addCleanup(self._restore_debug_flags)
832
def _clear_hooks(self):
833
# prevent hooks affecting tests
834
self._preserved_hooks = {}
835
for key, factory in hooks.known_hooks.items():
836
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
837
current_hooks = hooks.known_hooks_key_to_object(key)
838
self._preserved_hooks[parent] = (name, current_hooks)
839
self.addCleanup(self._restoreHooks)
840
for key, factory in hooks.known_hooks.items():
841
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
842
setattr(parent, name, factory())
843
# this hook should always be installed
844
request._install_hook()
846
def _silenceUI(self):
847
"""Turn off UI for duration of test"""
848
# by default the UI is off; tests can turn it on if they want it.
849
saved = ui.ui_factory
851
ui.ui_factory = saved
852
ui.ui_factory = ui.SilentUIFactory()
853
self.addCleanup(_restore)
855
def _check_locks(self):
856
"""Check that all lock take/release actions have been paired."""
857
# once we have fixed all the current lock problems, we can change the
858
# following code to always check for mismatched locks, but only do
859
# traceback showing with -Dlock (self._lock_check_thorough is True).
860
# For now, because the test suite will fail, we only assert that lock
861
# matching has occured with -Dlock.
863
acquired_locks = [lock for action, lock in self._lock_actions
864
if action == 'acquired']
865
released_locks = [lock for action, lock in self._lock_actions
866
if action == 'released']
867
# trivially, given the tests for lock acquistion and release, if we
868
# have as many in each list, it should be ok.
869
if len(acquired_locks) != len(released_locks):
871
("Different number of acquired and released locks. (%s, %s)" %
872
(acquired_locks, released_locks))
873
if not self._lock_check_thorough:
874
# Rather than fail, just warn
875
print "Broken test %s: %s" % (self, message)
879
def _track_locks(self):
880
"""Track lock activity during tests."""
881
self._lock_actions = []
882
self._lock_check_thorough = 'lock' in debug.debug_flags
883
self.addCleanup(self._check_locks)
884
_mod_lock.Lock.hooks.install_named_hook('lock_acquired', self._lock_acquired, None)
885
_mod_lock.Lock.hooks.install_named_hook('lock_released', self._lock_released, None)
887
def _lock_acquired(self, result):
888
self._lock_actions.append(('acquired', result))
890
def _lock_released(self, result):
891
self._lock_actions.append(('released', result))
893
def _ndiff_strings(self, a, b):
894
"""Return ndiff between two strings containing lines.
896
A trailing newline is added if missing to make the strings
898
if b and b[-1] != '\n':
900
if a and a[-1] != '\n':
902
difflines = difflib.ndiff(a.splitlines(True),
904
linejunk=lambda x: False,
905
charjunk=lambda x: False)
906
return ''.join(difflines)
908
def assertEqual(self, a, b, message=''):
912
except UnicodeError, e:
913
# If we can't compare without getting a UnicodeError, then
914
# obviously they are different
915
mutter('UnicodeError: %s', e)
918
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
920
pformat(a), pformat(b)))
922
assertEquals = assertEqual
924
def assertEqualDiff(self, a, b, message=None):
925
"""Assert two texts are equal, if not raise an exception.
927
This is intended for use with multi-line strings where it can
928
be hard to find the differences by eye.
930
# TODO: perhaps override assertEquals to call this for strings?
934
message = "texts not equal:\n"
936
message = 'first string is missing a final newline.\n'
938
message = 'second string is missing a final newline.\n'
939
raise AssertionError(message +
940
self._ndiff_strings(a, b))
942
def assertEqualMode(self, mode, mode_test):
943
self.assertEqual(mode, mode_test,
944
'mode mismatch %o != %o' % (mode, mode_test))
946
def assertEqualStat(self, expected, actual):
947
"""assert that expected and actual are the same stat result.
949
:param expected: A stat result.
950
:param actual: A stat result.
951
:raises AssertionError: If the expected and actual stat values differ
954
self.assertEqual(expected.st_size, actual.st_size)
955
self.assertEqual(expected.st_mtime, actual.st_mtime)
956
self.assertEqual(expected.st_ctime, actual.st_ctime)
957
self.assertEqual(expected.st_dev, actual.st_dev)
958
self.assertEqual(expected.st_ino, actual.st_ino)
959
self.assertEqual(expected.st_mode, actual.st_mode)
961
def assertLength(self, length, obj_with_len):
962
"""Assert that obj_with_len is of length length."""
963
if len(obj_with_len) != length:
964
self.fail("Incorrect length: wanted %d, got %d for %r" % (
965
length, len(obj_with_len), obj_with_len))
967
def assertPositive(self, val):
968
"""Assert that val is greater than 0."""
969
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
971
def assertNegative(self, val):
972
"""Assert that val is less than 0."""
973
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
975
def assertStartsWith(self, s, prefix):
976
if not s.startswith(prefix):
977
raise AssertionError('string %r does not start with %r' % (s, prefix))
979
def assertEndsWith(self, s, suffix):
980
"""Asserts that s ends with suffix."""
981
if not s.endswith(suffix):
982
raise AssertionError('string %r does not end with %r' % (s, suffix))
984
def assertContainsRe(self, haystack, needle_re, flags=0):
985
"""Assert that a contains something matching a regular expression."""
986
if not re.search(needle_re, haystack, flags):
987
if '\n' in haystack or len(haystack) > 60:
988
# a long string, format it in a more readable way
989
raise AssertionError(
990
'pattern "%s" not found in\n"""\\\n%s"""\n'
991
% (needle_re, haystack))
993
raise AssertionError('pattern "%s" not found in "%s"'
994
% (needle_re, haystack))
996
def assertNotContainsRe(self, haystack, needle_re, flags=0):
997
"""Assert that a does not match a regular expression"""
998
if re.search(needle_re, haystack, flags):
999
raise AssertionError('pattern "%s" found in "%s"'
1000
% (needle_re, haystack))
1002
def assertSubset(self, sublist, superlist):
1003
"""Assert that every entry in sublist is present in superlist."""
1004
missing = set(sublist) - set(superlist)
1005
if len(missing) > 0:
1006
raise AssertionError("value(s) %r not present in container %r" %
1007
(missing, superlist))
1009
def assertListRaises(self, excClass, func, *args, **kwargs):
1010
"""Fail unless excClass is raised when the iterator from func is used.
1012
Many functions can return generators this makes sure
1013
to wrap them in a list() call to make sure the whole generator
1014
is run, and that the proper exception is raised.
1017
list(func(*args, **kwargs))
1021
if getattr(excClass,'__name__', None) is not None:
1022
excName = excClass.__name__
1024
excName = str(excClass)
1025
raise self.failureException, "%s not raised" % excName
1027
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1028
"""Assert that a callable raises a particular exception.
1030
:param excClass: As for the except statement, this may be either an
1031
exception class, or a tuple of classes.
1032
:param callableObj: A callable, will be passed ``*args`` and
1035
Returns the exception so that you can examine it.
1038
callableObj(*args, **kwargs)
1042
if getattr(excClass,'__name__', None) is not None:
1043
excName = excClass.__name__
1046
excName = str(excClass)
1047
raise self.failureException, "%s not raised" % excName
1049
def assertIs(self, left, right, message=None):
1050
if not (left is right):
1051
if message is not None:
1052
raise AssertionError(message)
1054
raise AssertionError("%r is not %r." % (left, right))
1056
def assertIsNot(self, left, right, message=None):
1058
if message is not None:
1059
raise AssertionError(message)
1061
raise AssertionError("%r is %r." % (left, right))
1063
def assertTransportMode(self, transport, path, mode):
1064
"""Fail if a path does not have mode "mode".
1066
If modes are not supported on this transport, the assertion is ignored.
1068
if not transport._can_roundtrip_unix_modebits():
1070
path_stat = transport.stat(path)
1071
actual_mode = stat.S_IMODE(path_stat.st_mode)
1072
self.assertEqual(mode, actual_mode,
1073
'mode of %r incorrect (%s != %s)'
1074
% (path, oct(mode), oct(actual_mode)))
1076
def assertIsSameRealPath(self, path1, path2):
1077
"""Fail if path1 and path2 points to different files"""
1078
self.assertEqual(osutils.realpath(path1),
1079
osutils.realpath(path2),
1080
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1082
def assertIsInstance(self, obj, kls):
1083
"""Fail if obj is not an instance of kls"""
1084
if not isinstance(obj, kls):
1085
self.fail("%r is an instance of %s rather than %s" % (
1086
obj, obj.__class__, kls))
1088
def expectFailure(self, reason, assertion, *args, **kwargs):
1089
"""Invoke a test, expecting it to fail for the given reason.
1091
This is for assertions that ought to succeed, but currently fail.
1092
(The failure is *expected* but not *wanted*.) Please be very precise
1093
about the failure you're expecting. If a new bug is introduced,
1094
AssertionError should be raised, not KnownFailure.
1096
Frequently, expectFailure should be followed by an opposite assertion.
1099
Intended to be used with a callable that raises AssertionError as the
1100
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1102
Raises KnownFailure if the test fails. Raises AssertionError if the
1107
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1109
self.assertEqual(42, dynamic_val)
1111
This means that a dynamic_val of 54 will cause the test to raise
1112
a KnownFailure. Once math is fixed and the expectFailure is removed,
1113
only a dynamic_val of 42 will allow the test to pass. Anything other
1114
than 54 or 42 will cause an AssertionError.
1117
assertion(*args, **kwargs)
1118
except AssertionError:
1119
raise KnownFailure(reason)
1121
self.fail('Unexpected success. Should have failed: %s' % reason)
1123
def assertFileEqual(self, content, path):
1124
"""Fail if path does not contain 'content'."""
1125
self.failUnlessExists(path)
1126
f = file(path, 'rb')
1131
self.assertEqualDiff(content, s)
1133
def failUnlessExists(self, path):
1134
"""Fail unless path or paths, which may be abs or relative, exist."""
1135
if not isinstance(path, basestring):
1137
self.failUnlessExists(p)
1139
self.failUnless(osutils.lexists(path),path+" does not exist")
1141
def failIfExists(self, path):
1142
"""Fail if path or paths, which may be abs or relative, exist."""
1143
if not isinstance(path, basestring):
1145
self.failIfExists(p)
1147
self.failIf(osutils.lexists(path),path+" exists")
1149
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1150
"""A helper for callDeprecated and applyDeprecated.
1152
:param a_callable: A callable to call.
1153
:param args: The positional arguments for the callable
1154
:param kwargs: The keyword arguments for the callable
1155
:return: A tuple (warnings, result). result is the result of calling
1156
a_callable(``*args``, ``**kwargs``).
1159
def capture_warnings(msg, cls=None, stacklevel=None):
1160
# we've hooked into a deprecation specific callpath,
1161
# only deprecations should getting sent via it.
1162
self.assertEqual(cls, DeprecationWarning)
1163
local_warnings.append(msg)
1164
original_warning_method = symbol_versioning.warn
1165
symbol_versioning.set_warning_method(capture_warnings)
1167
result = a_callable(*args, **kwargs)
1169
symbol_versioning.set_warning_method(original_warning_method)
1170
return (local_warnings, result)
1172
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1173
"""Call a deprecated callable without warning the user.
1175
Note that this only captures warnings raised by symbol_versioning.warn,
1176
not other callers that go direct to the warning module.
1178
To test that a deprecated method raises an error, do something like
1181
self.assertRaises(errors.ReservedId,
1182
self.applyDeprecated,
1183
deprecated_in((1, 5, 0)),
1187
:param deprecation_format: The deprecation format that the callable
1188
should have been deprecated with. This is the same type as the
1189
parameter to deprecated_method/deprecated_function. If the
1190
callable is not deprecated with this format, an assertion error
1192
:param a_callable: A callable to call. This may be a bound method or
1193
a regular function. It will be called with ``*args`` and
1195
:param args: The positional arguments for the callable
1196
:param kwargs: The keyword arguments for the callable
1197
:return: The result of a_callable(``*args``, ``**kwargs``)
1199
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1201
expected_first_warning = symbol_versioning.deprecation_string(
1202
a_callable, deprecation_format)
1203
if len(call_warnings) == 0:
1204
self.fail("No deprecation warning generated by call to %s" %
1206
self.assertEqual(expected_first_warning, call_warnings[0])
1209
def callCatchWarnings(self, fn, *args, **kw):
1210
"""Call a callable that raises python warnings.
1212
The caller's responsible for examining the returned warnings.
1214
If the callable raises an exception, the exception is not
1215
caught and propagates up to the caller. In that case, the list
1216
of warnings is not available.
1218
:returns: ([warning_object, ...], fn_result)
1220
# XXX: This is not perfect, because it completely overrides the
1221
# warnings filters, and some code may depend on suppressing particular
1222
# warnings. It's the easiest way to insulate ourselves from -Werror,
1223
# though. -- Andrew, 20071062
1225
def _catcher(message, category, filename, lineno, file=None, line=None):
1226
# despite the name, 'message' is normally(?) a Warning subclass
1228
wlist.append(message)
1229
saved_showwarning = warnings.showwarning
1230
saved_filters = warnings.filters
1232
warnings.showwarning = _catcher
1233
warnings.filters = []
1234
result = fn(*args, **kw)
1236
warnings.showwarning = saved_showwarning
1237
warnings.filters = saved_filters
1238
return wlist, result
1240
def callDeprecated(self, expected, callable, *args, **kwargs):
1241
"""Assert that a callable is deprecated in a particular way.
1243
This is a very precise test for unusual requirements. The
1244
applyDeprecated helper function is probably more suited for most tests
1245
as it allows you to simply specify the deprecation format being used
1246
and will ensure that that is issued for the function being called.
1248
Note that this only captures warnings raised by symbol_versioning.warn,
1249
not other callers that go direct to the warning module. To catch
1250
general warnings, use callCatchWarnings.
1252
:param expected: a list of the deprecation warnings expected, in order
1253
:param callable: The callable to call
1254
:param args: The positional arguments for the callable
1255
:param kwargs: The keyword arguments for the callable
1257
call_warnings, result = self._capture_deprecation_warnings(callable,
1259
self.assertEqual(expected, call_warnings)
1262
def _startLogFile(self):
1263
"""Send bzr and test log messages to a temporary file.
1265
The file is removed as the test is torn down.
1267
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1268
self._log_file = os.fdopen(fileno, 'w+')
1269
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1270
self._log_file_name = name
1271
self.addCleanup(self._finishLogFile)
1273
def _finishLogFile(self):
1274
"""Finished with the log file.
1276
Close the file and delete it, unless setKeepLogfile was called.
1278
if self._log_file is None:
1280
bzrlib.trace.pop_log_file(self._log_memento)
1281
self._log_file.close()
1282
self._log_file = None
1283
if not self._keep_log_file:
1284
os.remove(self._log_file_name)
1285
self._log_file_name = None
1287
def setKeepLogfile(self):
1288
"""Make the logfile not be deleted when _finishLogFile is called."""
1289
self._keep_log_file = True
1291
def addCleanup(self, callable, *args, **kwargs):
1292
"""Arrange to run a callable when this case is torn down.
1294
Callables are run in the reverse of the order they are registered,
1295
ie last-in first-out.
1297
self._cleanups.append((callable, args, kwargs))
1299
def _cleanEnvironment(self):
1301
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1302
'HOME': os.getcwd(),
1303
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1304
# tests do check our impls match APPDATA
1305
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1309
'BZREMAIL': None, # may still be present in the environment
1311
'BZR_PROGRESS_BAR': None,
1313
'BZR_PLUGIN_PATH': None,
1315
'SSH_AUTH_SOCK': None,
1319
'https_proxy': None,
1320
'HTTPS_PROXY': None,
1325
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1326
# least. If you do (care), please update this comment
1330
'BZR_REMOTE_PATH': None,
1333
self.addCleanup(self._restoreEnvironment)
1334
for name, value in new_env.iteritems():
1335
self._captureVar(name, value)
1337
def _captureVar(self, name, newvalue):
1338
"""Set an environment variable, and reset it when finished."""
1339
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1341
def _restore_debug_flags(self):
1342
debug.debug_flags.clear()
1343
debug.debug_flags.update(self._preserved_debug_flags)
1345
def _restoreEnvironment(self):
1346
for name, value in self.__old_env.iteritems():
1347
osutils.set_or_unset_env(name, value)
1349
def _restoreHooks(self):
1350
for klass, (name, hooks) in self._preserved_hooks.items():
1351
setattr(klass, name, hooks)
1353
def knownFailure(self, reason):
1354
"""This test has failed for some known reason."""
1355
raise KnownFailure(reason)
1357
def _do_skip(self, result, reason):
1358
addSkip = getattr(result, 'addSkip', None)
1359
if not callable(addSkip):
1360
result.addError(self, sys.exc_info())
1362
addSkip(self, reason)
1364
def run(self, result=None):
1365
if result is None: result = self.defaultTestResult()
1366
for feature in getattr(self, '_test_needs_features', []):
1367
if not feature.available():
1368
result.startTest(self)
1369
if getattr(result, 'addNotSupported', None):
1370
result.addNotSupported(self, feature)
1372
result.addSuccess(self)
1373
result.stopTest(self)
1377
result.startTest(self)
1378
absent_attr = object()
1380
method_name = getattr(self, '_testMethodName', absent_attr)
1381
if method_name is absent_attr:
1383
method_name = getattr(self, '_TestCase__testMethodName')
1384
testMethod = getattr(self, method_name)
1388
if not self._bzr_test_setUp_run:
1390
"test setUp did not invoke "
1391
"bzrlib.tests.TestCase's setUp")
1392
except KeyboardInterrupt:
1394
except TestSkipped, e:
1395
self._do_skip(result, e.args[0])
1399
result.addError(self, sys.exc_info())
1406
except self.failureException:
1407
result.addFailure(self, sys.exc_info())
1408
except TestSkipped, e:
1410
reason = "No reason given."
1413
self._do_skip(result, reason)
1414
except KeyboardInterrupt:
1417
result.addError(self, sys.exc_info())
1421
if not self._bzr_test_tearDown_run:
1423
"test tearDown did not invoke "
1424
"bzrlib.tests.TestCase's tearDown")
1425
except KeyboardInterrupt:
1428
result.addError(self, sys.exc_info())
1430
if ok: result.addSuccess(self)
1432
result.stopTest(self)
1434
except TestNotApplicable:
1435
# Not moved from the result [yet].
1437
except KeyboardInterrupt:
1441
absent_attr = object()
1442
for attr_name in self.attrs_to_keep:
1443
attr = getattr(self, attr_name, absent_attr)
1444
if attr is not absent_attr:
1445
saved_attrs[attr_name] = attr
1446
self.__dict__ = saved_attrs
1449
self._bzr_test_tearDown_run = True
1451
self._log_contents = ''
1452
unittest.TestCase.tearDown(self)
1454
def time(self, callable, *args, **kwargs):
1455
"""Run callable and accrue the time it takes to the benchmark time.
1457
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1458
this will cause lsprofile statistics to be gathered and stored in
1461
if self._benchtime is None:
1465
if not self._gather_lsprof_in_benchmarks:
1466
return callable(*args, **kwargs)
1468
# record this benchmark
1469
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1471
self._benchcalls.append(((callable, args, kwargs), stats))
1474
self._benchtime += time.time() - start
1476
def _runCleanups(self):
1477
"""Run registered cleanup functions.
1479
This should only be called from TestCase.tearDown.
1481
# TODO: Perhaps this should keep running cleanups even if
1482
# one of them fails?
1484
# Actually pop the cleanups from the list so tearDown running
1485
# twice is safe (this happens for skipped tests).
1486
while self._cleanups:
1487
cleanup, args, kwargs = self._cleanups.pop()
1488
cleanup(*args, **kwargs)
1490
def log(self, *args):
1493
def _get_log(self, keep_log_file=False):
1494
"""Get the log from bzrlib.trace calls from this test.
1496
:param keep_log_file: When True, if the log is still a file on disk
1497
leave it as a file on disk. When False, if the log is still a file
1498
on disk, the log file is deleted and the log preserved as
1500
:return: A string containing the log.
1502
# flush the log file, to get all content
1504
if bzrlib.trace._trace_file:
1505
bzrlib.trace._trace_file.flush()
1506
if self._log_contents:
1507
# XXX: this can hardly contain the content flushed above --vila
1509
return self._log_contents
1510
if self._log_file_name is not None:
1511
logfile = open(self._log_file_name)
1513
log_contents = logfile.read()
1516
if not keep_log_file:
1517
self._log_contents = log_contents
1519
os.remove(self._log_file_name)
1521
if sys.platform == 'win32' and e.errno == errno.EACCES:
1522
sys.stderr.write(('Unable to delete log file '
1523
' %r\n' % self._log_file_name))
1528
return "DELETED log file to reduce memory footprint"
1530
def requireFeature(self, feature):
1531
"""This test requires a specific feature is available.
1533
:raises UnavailableFeature: When feature is not available.
1535
if not feature.available():
1536
raise UnavailableFeature(feature)
1538
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1540
"""Run bazaar command line, splitting up a string command line."""
1541
if isinstance(args, basestring):
1542
# shlex don't understand unicode strings,
1543
# so args should be plain string (bialix 20070906)
1544
args = list(shlex.split(str(args)))
1545
return self._run_bzr_core(args, retcode=retcode,
1546
encoding=encoding, stdin=stdin, working_dir=working_dir,
1549
def _run_bzr_core(self, args, retcode, encoding, stdin,
1551
if encoding is None:
1552
encoding = osutils.get_user_encoding()
1553
stdout = StringIOWrapper()
1554
stderr = StringIOWrapper()
1555
stdout.encoding = encoding
1556
stderr.encoding = encoding
1558
self.log('run bzr: %r', args)
1559
# FIXME: don't call into logging here
1560
handler = logging.StreamHandler(stderr)
1561
handler.setLevel(logging.INFO)
1562
logger = logging.getLogger('')
1563
logger.addHandler(handler)
1564
old_ui_factory = ui.ui_factory
1565
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1568
if working_dir is not None:
1569
cwd = osutils.getcwd()
1570
os.chdir(working_dir)
1573
result = self.apply_redirected(ui.ui_factory.stdin,
1575
bzrlib.commands.run_bzr_catch_user_errors,
1578
logger.removeHandler(handler)
1579
ui.ui_factory = old_ui_factory
1583
out = stdout.getvalue()
1584
err = stderr.getvalue()
1586
self.log('output:\n%r', out)
1588
self.log('errors:\n%r', err)
1589
if retcode is not None:
1590
self.assertEquals(retcode, result,
1591
message='Unexpected return code')
1594
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1595
working_dir=None, error_regexes=[], output_encoding=None):
1596
"""Invoke bzr, as if it were run from the command line.
1598
The argument list should not include the bzr program name - the
1599
first argument is normally the bzr command. Arguments may be
1600
passed in three ways:
1602
1- A list of strings, eg ["commit", "a"]. This is recommended
1603
when the command contains whitespace or metacharacters, or
1604
is built up at run time.
1606
2- A single string, eg "add a". This is the most convenient
1607
for hardcoded commands.
1609
This runs bzr through the interface that catches and reports
1610
errors, and with logging set to something approximating the
1611
default, so that error reporting can be checked.
1613
This should be the main method for tests that want to exercise the
1614
overall behavior of the bzr application (rather than a unit test
1615
or a functional test of the library.)
1617
This sends the stdout/stderr results into the test's log,
1618
where it may be useful for debugging. See also run_captured.
1620
:keyword stdin: A string to be used as stdin for the command.
1621
:keyword retcode: The status code the command should return;
1623
:keyword working_dir: The directory to run the command in
1624
:keyword error_regexes: A list of expected error messages. If
1625
specified they must be seen in the error output of the command.
1627
out, err = self._run_bzr_autosplit(
1632
working_dir=working_dir,
1634
for regex in error_regexes:
1635
self.assertContainsRe(err, regex)
1638
def run_bzr_error(self, error_regexes, *args, **kwargs):
1639
"""Run bzr, and check that stderr contains the supplied regexes
1641
:param error_regexes: Sequence of regular expressions which
1642
must each be found in the error output. The relative ordering
1644
:param args: command-line arguments for bzr
1645
:param kwargs: Keyword arguments which are interpreted by run_bzr
1646
This function changes the default value of retcode to be 3,
1647
since in most cases this is run when you expect bzr to fail.
1649
:return: (out, err) The actual output of running the command (in case
1650
you want to do more inspection)
1654
# Make sure that commit is failing because there is nothing to do
1655
self.run_bzr_error(['no changes to commit'],
1656
['commit', '-m', 'my commit comment'])
1657
# Make sure --strict is handling an unknown file, rather than
1658
# giving us the 'nothing to do' error
1659
self.build_tree(['unknown'])
1660
self.run_bzr_error(['Commit refused because there are unknown files'],
1661
['commit', --strict', '-m', 'my commit comment'])
1663
kwargs.setdefault('retcode', 3)
1664
kwargs['error_regexes'] = error_regexes
1665
out, err = self.run_bzr(*args, **kwargs)
1668
def run_bzr_subprocess(self, *args, **kwargs):
1669
"""Run bzr in a subprocess for testing.
1671
This starts a new Python interpreter and runs bzr in there.
1672
This should only be used for tests that have a justifiable need for
1673
this isolation: e.g. they are testing startup time, or signal
1674
handling, or early startup code, etc. Subprocess code can't be
1675
profiled or debugged so easily.
1677
:keyword retcode: The status code that is expected. Defaults to 0. If
1678
None is supplied, the status code is not checked.
1679
:keyword env_changes: A dictionary which lists changes to environment
1680
variables. A value of None will unset the env variable.
1681
The values must be strings. The change will only occur in the
1682
child, so you don't need to fix the environment after running.
1683
:keyword universal_newlines: Convert CRLF => LF
1684
:keyword allow_plugins: By default the subprocess is run with
1685
--no-plugins to ensure test reproducibility. Also, it is possible
1686
for system-wide plugins to create unexpected output on stderr,
1687
which can cause unnecessary test failures.
1689
env_changes = kwargs.get('env_changes', {})
1690
working_dir = kwargs.get('working_dir', None)
1691
allow_plugins = kwargs.get('allow_plugins', False)
1693
if isinstance(args[0], list):
1695
elif isinstance(args[0], basestring):
1696
args = list(shlex.split(args[0]))
1698
raise ValueError("passing varargs to run_bzr_subprocess")
1699
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1700
working_dir=working_dir,
1701
allow_plugins=allow_plugins)
1702
# We distinguish between retcode=None and retcode not passed.
1703
supplied_retcode = kwargs.get('retcode', 0)
1704
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1705
universal_newlines=kwargs.get('universal_newlines', False),
1708
def start_bzr_subprocess(self, process_args, env_changes=None,
1709
skip_if_plan_to_signal=False,
1711
allow_plugins=False):
1712
"""Start bzr in a subprocess for testing.
1714
This starts a new Python interpreter and runs bzr in there.
1715
This should only be used for tests that have a justifiable need for
1716
this isolation: e.g. they are testing startup time, or signal
1717
handling, or early startup code, etc. Subprocess code can't be
1718
profiled or debugged so easily.
1720
:param process_args: a list of arguments to pass to the bzr executable,
1721
for example ``['--version']``.
1722
:param env_changes: A dictionary which lists changes to environment
1723
variables. A value of None will unset the env variable.
1724
The values must be strings. The change will only occur in the
1725
child, so you don't need to fix the environment after running.
1726
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1728
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1730
:returns: Popen object for the started process.
1732
if skip_if_plan_to_signal:
1733
if not getattr(os, 'kill', None):
1734
raise TestSkipped("os.kill not available.")
1736
if env_changes is None:
1740
def cleanup_environment():
1741
for env_var, value in env_changes.iteritems():
1742
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1744
def restore_environment():
1745
for env_var, value in old_env.iteritems():
1746
osutils.set_or_unset_env(env_var, value)
1748
bzr_path = self.get_bzr_path()
1751
if working_dir is not None:
1752
cwd = osutils.getcwd()
1753
os.chdir(working_dir)
1756
# win32 subprocess doesn't support preexec_fn
1757
# so we will avoid using it on all platforms, just to
1758
# make sure the code path is used, and we don't break on win32
1759
cleanup_environment()
1760
command = [sys.executable]
1761
# frozen executables don't need the path to bzr
1762
if getattr(sys, "frozen", None) is None:
1763
command.append(bzr_path)
1764
if not allow_plugins:
1765
command.append('--no-plugins')
1766
command.extend(process_args)
1767
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1769
restore_environment()
1775
def _popen(self, *args, **kwargs):
1776
"""Place a call to Popen.
1778
Allows tests to override this method to intercept the calls made to
1779
Popen for introspection.
1781
return Popen(*args, **kwargs)
1783
def get_bzr_path(self):
1784
"""Return the path of the 'bzr' executable for this test suite."""
1785
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1786
if not os.path.isfile(bzr_path):
1787
# We are probably installed. Assume sys.argv is the right file
1788
bzr_path = sys.argv[0]
1791
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1792
universal_newlines=False, process_args=None):
1793
"""Finish the execution of process.
1795
:param process: the Popen object returned from start_bzr_subprocess.
1796
:param retcode: The status code that is expected. Defaults to 0. If
1797
None is supplied, the status code is not checked.
1798
:param send_signal: an optional signal to send to the process.
1799
:param universal_newlines: Convert CRLF => LF
1800
:returns: (stdout, stderr)
1802
if send_signal is not None:
1803
os.kill(process.pid, send_signal)
1804
out, err = process.communicate()
1806
if universal_newlines:
1807
out = out.replace('\r\n', '\n')
1808
err = err.replace('\r\n', '\n')
1810
if retcode is not None and retcode != process.returncode:
1811
if process_args is None:
1812
process_args = "(unknown args)"
1813
mutter('Output of bzr %s:\n%s', process_args, out)
1814
mutter('Error for bzr %s:\n%s', process_args, err)
1815
self.fail('Command bzr %s failed with retcode %s != %s'
1816
% (process_args, retcode, process.returncode))
1819
def check_inventory_shape(self, inv, shape):
1820
"""Compare an inventory to a list of expected names.
1822
Fail if they are not precisely equal.
1825
shape = list(shape) # copy
1826
for path, ie in inv.entries():
1827
name = path.replace('\\', '/')
1828
if ie.kind == 'directory':
1835
self.fail("expected paths not found in inventory: %r" % shape)
1837
self.fail("unexpected paths found in inventory: %r" % extras)
1839
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1840
a_callable=None, *args, **kwargs):
1841
"""Call callable with redirected std io pipes.
1843
Returns the return code."""
1844
if not callable(a_callable):
1845
raise ValueError("a_callable must be callable.")
1847
stdin = StringIO("")
1849
if getattr(self, "_log_file", None) is not None:
1850
stdout = self._log_file
1854
if getattr(self, "_log_file", None is not None):
1855
stderr = self._log_file
1858
real_stdin = sys.stdin
1859
real_stdout = sys.stdout
1860
real_stderr = sys.stderr
1865
return a_callable(*args, **kwargs)
1867
sys.stdout = real_stdout
1868
sys.stderr = real_stderr
1869
sys.stdin = real_stdin
1871
def reduceLockdirTimeout(self):
1872
"""Reduce the default lock timeout for the duration of the test, so that
1873
if LockContention occurs during a test, it does so quickly.
1875
Tests that expect to provoke LockContention errors should call this.
1877
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1879
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1880
self.addCleanup(resetTimeout)
1881
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1883
def make_utf8_encoded_stringio(self, encoding_type=None):
1884
"""Return a StringIOWrapper instance, that will encode Unicode
1887
if encoding_type is None:
1888
encoding_type = 'strict'
1890
output_encoding = 'utf-8'
1891
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1892
sio.encoding = output_encoding
1896
class CapturedCall(object):
1897
"""A helper for capturing smart server calls for easy debug analysis."""
1899
def __init__(self, params, prefix_length):
1900
"""Capture the call with params and skip prefix_length stack frames."""
1903
# The last 5 frames are the __init__, the hook frame, and 3 smart
1904
# client frames. Beyond this we could get more clever, but this is good
1906
stack = traceback.extract_stack()[prefix_length:-5]
1907
self.stack = ''.join(traceback.format_list(stack))
1910
return self.call.method
1913
return self.call.method
1919
class TestCaseWithMemoryTransport(TestCase):
1920
"""Common test class for tests that do not need disk resources.
1922
Tests that need disk resources should derive from TestCaseWithTransport.
1924
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1926
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1927
a directory which does not exist. This serves to help ensure test isolation
1928
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1929
must exist. However, TestCaseWithMemoryTransport does not offer local
1930
file defaults for the transport in tests, nor does it obey the command line
1931
override, so tests that accidentally write to the common directory should
1934
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1935
a .bzr directory that stops us ascending higher into the filesystem.
1941
def __init__(self, methodName='runTest'):
1942
# allow test parameterization after test construction and before test
1943
# execution. Variables that the parameterizer sets need to be
1944
# ones that are not set by setUp, or setUp will trash them.
1945
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1946
self.vfs_transport_factory = default_transport
1947
self.transport_server = None
1948
self.transport_readonly_server = None
1949
self.__vfs_server = None
1951
def get_transport(self, relpath=None):
1952
"""Return a writeable transport.
1954
This transport is for the test scratch space relative to
1957
:param relpath: a path relative to the base url.
1959
t = get_transport(self.get_url(relpath))
1960
self.assertFalse(t.is_readonly())
1963
def get_readonly_transport(self, relpath=None):
1964
"""Return a readonly transport for the test scratch space
1966
This can be used to test that operations which should only need
1967
readonly access in fact do not try to write.
1969
:param relpath: a path relative to the base url.
1971
t = get_transport(self.get_readonly_url(relpath))
1972
self.assertTrue(t.is_readonly())
1975
def create_transport_readonly_server(self):
1976
"""Create a transport server from class defined at init.
1978
This is mostly a hook for daughter classes.
1980
return self.transport_readonly_server()
1982
def get_readonly_server(self):
1983
"""Get the server instance for the readonly transport
1985
This is useful for some tests with specific servers to do diagnostics.
1987
if self.__readonly_server is None:
1988
if self.transport_readonly_server is None:
1989
# readonly decorator requested
1990
# bring up the server
1991
self.__readonly_server = ReadonlyServer()
1992
self.__readonly_server.setUp(self.get_vfs_only_server())
1994
self.__readonly_server = self.create_transport_readonly_server()
1995
self.__readonly_server.setUp(self.get_vfs_only_server())
1996
self.addCleanup(self.__readonly_server.tearDown)
1997
return self.__readonly_server
1999
def get_readonly_url(self, relpath=None):
2000
"""Get a URL for the readonly transport.
2002
This will either be backed by '.' or a decorator to the transport
2003
used by self.get_url()
2004
relpath provides for clients to get a path relative to the base url.
2005
These should only be downwards relative, not upwards.
2007
base = self.get_readonly_server().get_url()
2008
return self._adjust_url(base, relpath)
2010
def get_vfs_only_server(self):
2011
"""Get the vfs only read/write server instance.
2013
This is useful for some tests with specific servers that need
2016
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2017
is no means to override it.
2019
if self.__vfs_server is None:
2020
self.__vfs_server = MemoryServer()
2021
self.__vfs_server.setUp()
2022
self.addCleanup(self.__vfs_server.tearDown)
2023
return self.__vfs_server
2025
def get_server(self):
2026
"""Get the read/write server instance.
2028
This is useful for some tests with specific servers that need
2031
This is built from the self.transport_server factory. If that is None,
2032
then the self.get_vfs_server is returned.
2034
if self.__server is None:
2035
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2036
return self.get_vfs_only_server()
2038
# bring up a decorated means of access to the vfs only server.
2039
self.__server = self.transport_server()
2041
self.__server.setUp(self.get_vfs_only_server())
2042
except TypeError, e:
2043
# This should never happen; the try:Except here is to assist
2044
# developers having to update code rather than seeing an
2045
# uninformative TypeError.
2046
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2047
self.addCleanup(self.__server.tearDown)
2048
return self.__server
2050
def _adjust_url(self, base, relpath):
2051
"""Get a URL (or maybe a path) for the readwrite transport.
2053
This will either be backed by '.' or to an equivalent non-file based
2055
relpath provides for clients to get a path relative to the base url.
2056
These should only be downwards relative, not upwards.
2058
if relpath is not None and relpath != '.':
2059
if not base.endswith('/'):
2061
# XXX: Really base should be a url; we did after all call
2062
# get_url()! But sometimes it's just a path (from
2063
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2064
# to a non-escaped local path.
2065
if base.startswith('./') or base.startswith('/'):
2068
base += urlutils.escape(relpath)
2071
def get_url(self, relpath=None):
2072
"""Get a URL (or maybe a path) for the readwrite transport.
2074
This will either be backed by '.' or to an equivalent non-file based
2076
relpath provides for clients to get a path relative to the base url.
2077
These should only be downwards relative, not upwards.
2079
base = self.get_server().get_url()
2080
return self._adjust_url(base, relpath)
2082
def get_vfs_only_url(self, relpath=None):
2083
"""Get a URL (or maybe a path for the plain old vfs transport.
2085
This will never be a smart protocol. It always has all the
2086
capabilities of the local filesystem, but it might actually be a
2087
MemoryTransport or some other similar virtual filesystem.
2089
This is the backing transport (if any) of the server returned by
2090
get_url and get_readonly_url.
2092
:param relpath: provides for clients to get a path relative to the base
2093
url. These should only be downwards relative, not upwards.
2096
base = self.get_vfs_only_server().get_url()
2097
return self._adjust_url(base, relpath)
2099
def _create_safety_net(self):
2100
"""Make a fake bzr directory.
2102
This prevents any tests propagating up onto the TEST_ROOT directory's
2105
root = TestCaseWithMemoryTransport.TEST_ROOT
2106
bzrdir.BzrDir.create_standalone_workingtree(root)
2108
def _check_safety_net(self):
2109
"""Check that the safety .bzr directory have not been touched.
2111
_make_test_root have created a .bzr directory to prevent tests from
2112
propagating. This method ensures than a test did not leaked.
2114
root = TestCaseWithMemoryTransport.TEST_ROOT
2115
wt = workingtree.WorkingTree.open(root)
2116
last_rev = wt.last_revision()
2117
if last_rev != 'null:':
2118
# The current test have modified the /bzr directory, we need to
2119
# recreate a new one or all the followng tests will fail.
2120
# If you need to inspect its content uncomment the following line
2121
# import pdb; pdb.set_trace()
2122
_rmtree_temp_dir(root + '/.bzr')
2123
self._create_safety_net()
2124
raise AssertionError('%s/.bzr should not be modified' % root)
2126
def _make_test_root(self):
2127
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2128
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2129
TestCaseWithMemoryTransport.TEST_ROOT = root
2131
self._create_safety_net()
2133
# The same directory is used by all tests, and we're not
2134
# specifically told when all tests are finished. This will do.
2135
atexit.register(_rmtree_temp_dir, root)
2137
self.addCleanup(self._check_safety_net)
2139
def makeAndChdirToTestDir(self):
2140
"""Create a temporary directories for this one test.
2142
This must set self.test_home_dir and self.test_dir and chdir to
2145
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2147
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2148
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2149
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2151
def make_branch(self, relpath, format=None):
2152
"""Create a branch on the transport at relpath."""
2153
repo = self.make_repository(relpath, format=format)
2154
return repo.bzrdir.create_branch()
2156
def make_bzrdir(self, relpath, format=None):
2158
# might be a relative or absolute path
2159
maybe_a_url = self.get_url(relpath)
2160
segments = maybe_a_url.rsplit('/', 1)
2161
t = get_transport(maybe_a_url)
2162
if len(segments) > 1 and segments[-1] not in ('', '.'):
2166
if isinstance(format, basestring):
2167
format = bzrdir.format_registry.make_bzrdir(format)
2168
return format.initialize_on_transport(t)
2169
except errors.UninitializableFormat:
2170
raise TestSkipped("Format %s is not initializable." % format)
2172
def make_repository(self, relpath, shared=False, format=None):
2173
"""Create a repository on our default transport at relpath.
2175
Note that relpath must be a relative path, not a full url.
2177
# FIXME: If you create a remoterepository this returns the underlying
2178
# real format, which is incorrect. Actually we should make sure that
2179
# RemoteBzrDir returns a RemoteRepository.
2180
# maybe mbp 20070410
2181
made_control = self.make_bzrdir(relpath, format=format)
2182
return made_control.create_repository(shared=shared)
2184
def make_smart_server(self, path):
2185
smart_server = server.SmartTCPServer_for_testing()
2186
smart_server.setUp(self.get_server())
2187
remote_transport = get_transport(smart_server.get_url()).clone(path)
2188
self.addCleanup(smart_server.tearDown)
2189
return remote_transport
2191
def make_branch_and_memory_tree(self, relpath, format=None):
2192
"""Create a branch on the default transport and a MemoryTree for it."""
2193
b = self.make_branch(relpath, format=format)
2194
return memorytree.MemoryTree.create_on_branch(b)
2196
def make_branch_builder(self, relpath, format=None):
2197
branch = self.make_branch(relpath, format=format)
2198
return branchbuilder.BranchBuilder(branch=branch)
2200
def overrideEnvironmentForTesting(self):
2201
os.environ['HOME'] = self.test_home_dir
2202
os.environ['BZR_HOME'] = self.test_home_dir
2205
super(TestCaseWithMemoryTransport, self).setUp()
2206
self._make_test_root()
2207
_currentdir = os.getcwdu()
2208
def _leaveDirectory():
2209
os.chdir(_currentdir)
2210
self.addCleanup(_leaveDirectory)
2211
self.makeAndChdirToTestDir()
2212
self.overrideEnvironmentForTesting()
2213
self.__readonly_server = None
2214
self.__server = None
2215
self.reduceLockdirTimeout()
2217
def setup_smart_server_with_call_log(self):
2218
"""Sets up a smart server as the transport server with a call log."""
2219
self.transport_server = server.SmartTCPServer_for_testing
2220
self.hpss_calls = []
2222
# Skip the current stack down to the caller of
2223
# setup_smart_server_with_call_log
2224
prefix_length = len(traceback.extract_stack()) - 2
2225
def capture_hpss_call(params):
2226
self.hpss_calls.append(
2227
CapturedCall(params, prefix_length))
2228
client._SmartClient.hooks.install_named_hook(
2229
'call', capture_hpss_call, None)
2231
def reset_smart_call_log(self):
2232
self.hpss_calls = []
2235
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2236
"""Derived class that runs a test within a temporary directory.
2238
This is useful for tests that need to create a branch, etc.
2240
The directory is created in a slightly complex way: for each
2241
Python invocation, a new temporary top-level directory is created.
2242
All test cases create their own directory within that. If the
2243
tests complete successfully, the directory is removed.
2245
:ivar test_base_dir: The path of the top-level directory for this
2246
test, which contains a home directory and a work directory.
2248
:ivar test_home_dir: An initially empty directory under test_base_dir
2249
which is used as $HOME for this test.
2251
:ivar test_dir: A directory under test_base_dir used as the current
2252
directory when the test proper is run.
2255
OVERRIDE_PYTHON = 'python'
2257
def check_file_contents(self, filename, expect):
2258
self.log("check contents of file %s" % filename)
2259
contents = file(filename, 'r').read()
2260
if contents != expect:
2261
self.log("expected: %r" % expect)
2262
self.log("actually: %r" % contents)
2263
self.fail("contents of %s not as expected" % filename)
2265
def _getTestDirPrefix(self):
2266
# create a directory within the top level test directory
2267
if sys.platform == 'win32':
2268
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2269
# windows is likely to have path-length limits so use a short name
2270
name_prefix = name_prefix[-30:]
2272
name_prefix = re.sub('[/]', '_', self.id())
2275
def makeAndChdirToTestDir(self):
2276
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2278
For TestCaseInTempDir we create a temporary directory based on the test
2279
name and then create two subdirs - test and home under it.
2281
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2282
self._getTestDirPrefix())
2284
for i in range(100):
2285
if os.path.exists(name):
2286
name = name_prefix + '_' + str(i)
2290
# now create test and home directories within this dir
2291
self.test_base_dir = name
2292
self.test_home_dir = self.test_base_dir + '/home'
2293
os.mkdir(self.test_home_dir)
2294
self.test_dir = self.test_base_dir + '/work'
2295
os.mkdir(self.test_dir)
2296
os.chdir(self.test_dir)
2297
# put name of test inside
2298
f = file(self.test_base_dir + '/name', 'w')
2303
self.addCleanup(self.deleteTestDir)
2305
def deleteTestDir(self):
2306
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2307
_rmtree_temp_dir(self.test_base_dir)
2309
def build_tree(self, shape, line_endings='binary', transport=None):
2310
"""Build a test tree according to a pattern.
2312
shape is a sequence of file specifications. If the final
2313
character is '/', a directory is created.
2315
This assumes that all the elements in the tree being built are new.
2317
This doesn't add anything to a branch.
2319
:type shape: list or tuple.
2320
:param line_endings: Either 'binary' or 'native'
2321
in binary mode, exact contents are written in native mode, the
2322
line endings match the default platform endings.
2323
:param transport: A transport to write to, for building trees on VFS's.
2324
If the transport is readonly or None, "." is opened automatically.
2327
if type(shape) not in (list, tuple):
2328
raise AssertionError("Parameter 'shape' should be "
2329
"a list or a tuple. Got %r instead" % (shape,))
2330
# It's OK to just create them using forward slashes on windows.
2331
if transport is None or transport.is_readonly():
2332
transport = get_transport(".")
2334
self.assertIsInstance(name, basestring)
2336
transport.mkdir(urlutils.escape(name[:-1]))
2338
if line_endings == 'binary':
2340
elif line_endings == 'native':
2343
raise errors.BzrError(
2344
'Invalid line ending request %r' % line_endings)
2345
content = "contents of %s%s" % (name.encode('utf-8'), end)
2346
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2348
def build_tree_contents(self, shape):
2349
build_tree_contents(shape)
2351
def assertInWorkingTree(self, path, root_path='.', tree=None):
2352
"""Assert whether path or paths are in the WorkingTree"""
2354
tree = workingtree.WorkingTree.open(root_path)
2355
if not isinstance(path, basestring):
2357
self.assertInWorkingTree(p, tree=tree)
2359
self.assertIsNot(tree.path2id(path), None,
2360
path+' not in working tree.')
2362
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2363
"""Assert whether path or paths are not in the WorkingTree"""
2365
tree = workingtree.WorkingTree.open(root_path)
2366
if not isinstance(path, basestring):
2368
self.assertNotInWorkingTree(p,tree=tree)
2370
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2373
class TestCaseWithTransport(TestCaseInTempDir):
2374
"""A test case that provides get_url and get_readonly_url facilities.
2376
These back onto two transport servers, one for readonly access and one for
2379
If no explicit class is provided for readonly access, a
2380
ReadonlyTransportDecorator is used instead which allows the use of non disk
2381
based read write transports.
2383
If an explicit class is provided for readonly access, that server and the
2384
readwrite one must both define get_url() as resolving to os.getcwd().
2387
def get_vfs_only_server(self):
2388
"""See TestCaseWithMemoryTransport.
2390
This is useful for some tests with specific servers that need
2393
if self.__vfs_server is None:
2394
self.__vfs_server = self.vfs_transport_factory()
2395
self.__vfs_server.setUp()
2396
self.addCleanup(self.__vfs_server.tearDown)
2397
return self.__vfs_server
2399
def make_branch_and_tree(self, relpath, format=None):
2400
"""Create a branch on the transport and a tree locally.
2402
If the transport is not a LocalTransport, the Tree can't be created on
2403
the transport. In that case if the vfs_transport_factory is
2404
LocalURLServer the working tree is created in the local
2405
directory backing the transport, and the returned tree's branch and
2406
repository will also be accessed locally. Otherwise a lightweight
2407
checkout is created and returned.
2409
:param format: The BzrDirFormat.
2410
:returns: the WorkingTree.
2412
# TODO: always use the local disk path for the working tree,
2413
# this obviously requires a format that supports branch references
2414
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2416
b = self.make_branch(relpath, format=format)
2418
return b.bzrdir.create_workingtree()
2419
except errors.NotLocalUrl:
2420
# We can only make working trees locally at the moment. If the
2421
# transport can't support them, then we keep the non-disk-backed
2422
# branch and create a local checkout.
2423
if self.vfs_transport_factory is LocalURLServer:
2424
# the branch is colocated on disk, we cannot create a checkout.
2425
# hopefully callers will expect this.
2426
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2427
wt = local_controldir.create_workingtree()
2428
if wt.branch._format != b._format:
2430
# Make sure that assigning to wt._branch fixes wt.branch,
2431
# in case the implementation details of workingtree objects
2433
self.assertIs(b, wt.branch)
2436
return b.create_checkout(relpath, lightweight=True)
2438
def assertIsDirectory(self, relpath, transport):
2439
"""Assert that relpath within transport is a directory.
2441
This may not be possible on all transports; in that case it propagates
2442
a TransportNotPossible.
2445
mode = transport.stat(relpath).st_mode
2446
except errors.NoSuchFile:
2447
self.fail("path %s is not a directory; no such file"
2449
if not stat.S_ISDIR(mode):
2450
self.fail("path %s is not a directory; has mode %#o"
2453
def assertTreesEqual(self, left, right):
2454
"""Check that left and right have the same content and properties."""
2455
# we use a tree delta to check for equality of the content, and we
2456
# manually check for equality of other things such as the parents list.
2457
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2458
differences = left.changes_from(right)
2459
self.assertFalse(differences.has_changed(),
2460
"Trees %r and %r are different: %r" % (left, right, differences))
2463
super(TestCaseWithTransport, self).setUp()
2464
self.__vfs_server = None
2467
class ChrootedTestCase(TestCaseWithTransport):
2468
"""A support class that provides readonly urls outside the local namespace.
2470
This is done by checking if self.transport_server is a MemoryServer. if it
2471
is then we are chrooted already, if it is not then an HttpServer is used
2474
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2475
be used without needed to redo it when a different
2476
subclass is in use ?
2480
super(ChrootedTestCase, self).setUp()
2481
if not self.vfs_transport_factory == MemoryServer:
2482
self.transport_readonly_server = HttpServer
2485
def condition_id_re(pattern):
2486
"""Create a condition filter which performs a re check on a test's id.
2488
:param pattern: A regular expression string.
2489
:return: A callable that returns True if the re matches.
2491
filter_re = osutils.re_compile_checked(pattern, 0,
2493
def condition(test):
2495
return filter_re.search(test_id)
2499
def condition_isinstance(klass_or_klass_list):
2500
"""Create a condition filter which returns isinstance(param, klass).
2502
:return: A callable which when called with one parameter obj return the
2503
result of isinstance(obj, klass_or_klass_list).
2506
return isinstance(obj, klass_or_klass_list)
2510
def condition_id_in_list(id_list):
2511
"""Create a condition filter which verify that test's id in a list.
2513
:param id_list: A TestIdList object.
2514
:return: A callable that returns True if the test's id appears in the list.
2516
def condition(test):
2517
return id_list.includes(test.id())
2521
def condition_id_startswith(starts):
2522
"""Create a condition filter verifying that test's id starts with a string.
2524
:param starts: A list of string.
2525
:return: A callable that returns True if the test's id starts with one of
2528
def condition(test):
2529
for start in starts:
2530
if test.id().startswith(start):
2536
def exclude_tests_by_condition(suite, condition):
2537
"""Create a test suite which excludes some tests from suite.
2539
:param suite: The suite to get tests from.
2540
:param condition: A callable whose result evaluates True when called with a
2541
test case which should be excluded from the result.
2542
:return: A suite which contains the tests found in suite that fail
2546
for test in iter_suite_tests(suite):
2547
if not condition(test):
2549
return TestUtil.TestSuite(result)
2552
def filter_suite_by_condition(suite, condition):
2553
"""Create a test suite by filtering another one.
2555
:param suite: The source suite.
2556
:param condition: A callable whose result evaluates True when called with a
2557
test case which should be included in the result.
2558
:return: A suite which contains the tests found in suite that pass
2562
for test in iter_suite_tests(suite):
2565
return TestUtil.TestSuite(result)
2568
def filter_suite_by_re(suite, pattern):
2569
"""Create a test suite by filtering another one.
2571
:param suite: the source suite
2572
:param pattern: pattern that names must match
2573
:returns: the newly created suite
2575
condition = condition_id_re(pattern)
2576
result_suite = filter_suite_by_condition(suite, condition)
2580
def filter_suite_by_id_list(suite, test_id_list):
2581
"""Create a test suite by filtering another one.
2583
:param suite: The source suite.
2584
:param test_id_list: A list of the test ids to keep as strings.
2585
:returns: the newly created suite
2587
condition = condition_id_in_list(test_id_list)
2588
result_suite = filter_suite_by_condition(suite, condition)
2592
def filter_suite_by_id_startswith(suite, start):
2593
"""Create a test suite by filtering another one.
2595
:param suite: The source suite.
2596
:param start: A list of string the test id must start with one of.
2597
:returns: the newly created suite
2599
condition = condition_id_startswith(start)
2600
result_suite = filter_suite_by_condition(suite, condition)
2604
def exclude_tests_by_re(suite, pattern):
2605
"""Create a test suite which excludes some tests from suite.
2607
:param suite: The suite to get tests from.
2608
:param pattern: A regular expression string. Test ids that match this
2609
pattern will be excluded from the result.
2610
:return: A TestSuite that contains all the tests from suite without the
2611
tests that matched pattern. The order of tests is the same as it was in
2614
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2617
def preserve_input(something):
2618
"""A helper for performing test suite transformation chains.
2620
:param something: Anything you want to preserve.
2626
def randomize_suite(suite):
2627
"""Return a new TestSuite with suite's tests in random order.
2629
The tests in the input suite are flattened into a single suite in order to
2630
accomplish this. Any nested TestSuites are removed to provide global
2633
tests = list(iter_suite_tests(suite))
2634
random.shuffle(tests)
2635
return TestUtil.TestSuite(tests)
2638
def split_suite_by_condition(suite, condition):
2639
"""Split a test suite into two by a condition.
2641
:param suite: The suite to split.
2642
:param condition: The condition to match on. Tests that match this
2643
condition are returned in the first test suite, ones that do not match
2644
are in the second suite.
2645
:return: A tuple of two test suites, where the first contains tests from
2646
suite matching the condition, and the second contains the remainder
2647
from suite. The order within each output suite is the same as it was in
2652
for test in iter_suite_tests(suite):
2654
matched.append(test)
2656
did_not_match.append(test)
2657
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2660
def split_suite_by_re(suite, pattern):
2661
"""Split a test suite into two by a regular expression.
2663
:param suite: The suite to split.
2664
:param pattern: A regular expression string. Test ids that match this
2665
pattern will be in the first test suite returned, and the others in the
2666
second test suite returned.
2667
:return: A tuple of two test suites, where the first contains tests from
2668
suite matching pattern, and the second contains the remainder from
2669
suite. The order within each output suite is the same as it was in
2672
return split_suite_by_condition(suite, condition_id_re(pattern))
2675
def run_suite(suite, name='test', verbose=False, pattern=".*",
2676
stop_on_failure=False,
2677
transport=None, lsprof_timed=None, bench_history=None,
2678
matching_tests_first=None,
2681
exclude_pattern=None,
2684
suite_decorators=None,
2686
"""Run a test suite for bzr selftest.
2688
:param runner_class: The class of runner to use. Must support the
2689
constructor arguments passed by run_suite which are more than standard
2691
:return: A boolean indicating success.
2693
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2698
if runner_class is None:
2699
runner_class = TextTestRunner
2702
runner = runner_class(stream=stream,
2704
verbosity=verbosity,
2705
bench_history=bench_history,
2706
list_only=list_only,
2709
runner.stop_on_failure=stop_on_failure
2710
# built in decorator factories:
2712
random_order(random_seed, runner),
2713
exclude_tests(exclude_pattern),
2715
if matching_tests_first:
2716
decorators.append(tests_first(pattern))
2718
decorators.append(filter_tests(pattern))
2719
if suite_decorators:
2720
decorators.extend(suite_decorators)
2721
for decorator in decorators:
2722
suite = decorator(suite)
2723
result = runner.run(suite)
2728
return result.wasStrictlySuccessful()
2730
return result.wasSuccessful()
2733
# A registry where get() returns a suite decorator.
2734
parallel_registry = registry.Registry()
2737
def fork_decorator(suite):
2738
concurrency = local_concurrency()
2739
if concurrency == 1:
2741
from testtools import ConcurrentTestSuite
2742
return ConcurrentTestSuite(suite, fork_for_tests)
2743
parallel_registry.register('fork', fork_decorator)
2746
def subprocess_decorator(suite):
2747
concurrency = local_concurrency()
2748
if concurrency == 1:
2750
from testtools import ConcurrentTestSuite
2751
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2752
parallel_registry.register('subprocess', subprocess_decorator)
2755
def exclude_tests(exclude_pattern):
2756
"""Return a test suite decorator that excludes tests."""
2757
if exclude_pattern is None:
2758
return identity_decorator
2759
def decorator(suite):
2760
return ExcludeDecorator(suite, exclude_pattern)
2764
def filter_tests(pattern):
2766
return identity_decorator
2767
def decorator(suite):
2768
return FilterTestsDecorator(suite, pattern)
2772
def random_order(random_seed, runner):
2773
"""Return a test suite decorator factory for randomising tests order.
2775
:param random_seed: now, a string which casts to a long, or a long.
2776
:param runner: A test runner with a stream attribute to report on.
2778
if random_seed is None:
2779
return identity_decorator
2780
def decorator(suite):
2781
return RandomDecorator(suite, random_seed, runner.stream)
2785
def tests_first(pattern):
2787
return identity_decorator
2788
def decorator(suite):
2789
return TestFirstDecorator(suite, pattern)
2793
def identity_decorator(suite):
2798
class TestDecorator(TestSuite):
2799
"""A decorator for TestCase/TestSuite objects.
2801
Usually, subclasses should override __iter__(used when flattening test
2802
suites), which we do to filter, reorder, parallelise and so on, run() and
2806
def __init__(self, suite):
2807
TestSuite.__init__(self)
2810
def countTestCases(self):
2813
cases += test.countTestCases()
2820
def run(self, result):
2821
# Use iteration on self, not self._tests, to allow subclasses to hook
2824
if result.shouldStop:
2830
class ExcludeDecorator(TestDecorator):
2831
"""A decorator which excludes test matching an exclude pattern."""
2833
def __init__(self, suite, exclude_pattern):
2834
TestDecorator.__init__(self, suite)
2835
self.exclude_pattern = exclude_pattern
2836
self.excluded = False
2840
return iter(self._tests)
2841
self.excluded = True
2842
suite = exclude_tests_by_re(self, self.exclude_pattern)
2844
self.addTests(suite)
2845
return iter(self._tests)
2848
class FilterTestsDecorator(TestDecorator):
2849
"""A decorator which filters tests to those matching a pattern."""
2851
def __init__(self, suite, pattern):
2852
TestDecorator.__init__(self, suite)
2853
self.pattern = pattern
2854
self.filtered = False
2858
return iter(self._tests)
2859
self.filtered = True
2860
suite = filter_suite_by_re(self, self.pattern)
2862
self.addTests(suite)
2863
return iter(self._tests)
2866
class RandomDecorator(TestDecorator):
2867
"""A decorator which randomises the order of its tests."""
2869
def __init__(self, suite, random_seed, stream):
2870
TestDecorator.__init__(self, suite)
2871
self.random_seed = random_seed
2872
self.randomised = False
2873
self.stream = stream
2877
return iter(self._tests)
2878
self.randomised = True
2879
self.stream.writeln("Randomizing test order using seed %s\n" %
2880
(self.actual_seed()))
2881
# Initialise the random number generator.
2882
random.seed(self.actual_seed())
2883
suite = randomize_suite(self)
2885
self.addTests(suite)
2886
return iter(self._tests)
2888
def actual_seed(self):
2889
if self.random_seed == "now":
2890
# We convert the seed to a long to make it reuseable across
2891
# invocations (because the user can reenter it).
2892
self.random_seed = long(time.time())
2894
# Convert the seed to a long if we can
2896
self.random_seed = long(self.random_seed)
2899
return self.random_seed
2902
class TestFirstDecorator(TestDecorator):
2903
"""A decorator which moves named tests to the front."""
2905
def __init__(self, suite, pattern):
2906
TestDecorator.__init__(self, suite)
2907
self.pattern = pattern
2908
self.filtered = False
2912
return iter(self._tests)
2913
self.filtered = True
2914
suites = split_suite_by_re(self, self.pattern)
2916
self.addTests(suites)
2917
return iter(self._tests)
2920
def partition_tests(suite, count):
2921
"""Partition suite into count lists of tests."""
2923
tests = list(iter_suite_tests(suite))
2924
tests_per_process = int(math.ceil(float(len(tests)) / count))
2925
for block in range(count):
2926
low_test = block * tests_per_process
2927
high_test = low_test + tests_per_process
2928
process_tests = tests[low_test:high_test]
2929
result.append(process_tests)
2933
def fork_for_tests(suite):
2934
"""Take suite and start up one runner per CPU by forking()
2936
:return: An iterable of TestCase-like objects which can each have
2937
run(result) called on them to feed tests to result.
2939
concurrency = local_concurrency()
2941
from subunit import TestProtocolClient, ProtocolTestCase
2942
class TestInOtherProcess(ProtocolTestCase):
2943
# Should be in subunit, I think. RBC.
2944
def __init__(self, stream, pid):
2945
ProtocolTestCase.__init__(self, stream)
2948
def run(self, result):
2950
ProtocolTestCase.run(self, result)
2952
os.waitpid(self.pid, os.WNOHANG)
2954
test_blocks = partition_tests(suite, concurrency)
2955
for process_tests in test_blocks:
2956
process_suite = TestSuite()
2957
process_suite.addTests(process_tests)
2958
c2pread, c2pwrite = os.pipe()
2963
# Leave stderr and stdout open so we can see test noise
2964
# Close stdin so that the child goes away if it decides to
2965
# read from stdin (otherwise its a roulette to see what
2966
# child actually gets keystrokes for pdb etc).
2969
stream = os.fdopen(c2pwrite, 'wb', 1)
2970
subunit_result = TestProtocolClient(stream)
2971
process_suite.run(subunit_result)
2976
stream = os.fdopen(c2pread, 'rb', 1)
2977
test = TestInOtherProcess(stream, pid)
2982
def reinvoke_for_tests(suite):
2983
"""Take suite and start up one runner per CPU using subprocess().
2985
:return: An iterable of TestCase-like objects which can each have
2986
run(result) called on them to feed tests to result.
2988
concurrency = local_concurrency()
2990
from subunit import TestProtocolClient, ProtocolTestCase
2991
class TestInSubprocess(ProtocolTestCase):
2992
def __init__(self, process, name):
2993
ProtocolTestCase.__init__(self, process.stdout)
2994
self.process = process
2995
self.process.stdin.close()
2998
def run(self, result):
3000
ProtocolTestCase.run(self, result)
3003
os.unlink(self.name)
3004
# print "pid %d finished" % finished_process
3005
test_blocks = partition_tests(suite, concurrency)
3006
for process_tests in test_blocks:
3007
# ugly; currently reimplement rather than reuses TestCase methods.
3008
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3009
if not os.path.isfile(bzr_path):
3010
# We are probably installed. Assume sys.argv is the right file
3011
bzr_path = sys.argv[0]
3012
fd, test_list_file_name = tempfile.mkstemp()
3013
test_list_file = os.fdopen(fd, 'wb', 1)
3014
for test in process_tests:
3015
test_list_file.write(test.id() + '\n')
3016
test_list_file.close()
3018
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3020
if '--no-plugins' in sys.argv:
3021
argv.append('--no-plugins')
3022
# stderr=STDOUT would be ideal, but until we prevent noise on
3023
# stderr it can interrupt the subunit protocol.
3024
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3026
test = TestInSubprocess(process, test_list_file_name)
3029
os.unlink(test_list_file_name)
3034
def cpucount(content):
3035
lines = content.splitlines()
3036
prefix = 'processor'
3038
if line.startswith(prefix):
3039
concurrency = int(line[line.find(':')+1:]) + 1
3043
def local_concurrency():
3045
content = file('/proc/cpuinfo', 'rb').read()
3046
concurrency = cpucount(content)
3047
except Exception, e:
3052
class BZRTransformingResult(unittest.TestResult):
3054
def __init__(self, target):
3055
unittest.TestResult.__init__(self)
3056
self.result = target
3058
def startTest(self, test):
3059
self.result.startTest(test)
3061
def stopTest(self, test):
3062
self.result.stopTest(test)
3064
def addError(self, test, err):
3065
feature = self._error_looks_like('UnavailableFeature: ', err)
3066
if feature is not None:
3067
self.result.addNotSupported(test, feature)
3069
self.result.addError(test, err)
3071
def addFailure(self, test, err):
3072
known = self._error_looks_like('KnownFailure: ', err)
3073
if known is not None:
3074
self.result._addKnownFailure(test, [KnownFailure,
3075
KnownFailure(known), None])
3077
self.result.addFailure(test, err)
3079
def addSkip(self, test, reason):
3080
self.result.addSkip(test, reason)
3082
def addSuccess(self, test):
3083
self.result.addSuccess(test)
3085
def _error_looks_like(self, prefix, err):
3086
"""Deserialize exception and returns the stringify value."""
3090
if isinstance(exc, subunit.RemoteException):
3091
# stringify the exception gives access to the remote traceback
3092
# We search the last line for 'prefix'
3093
lines = str(exc).split('\n')
3094
while lines and not lines[-1]:
3097
if lines[-1].startswith(prefix):
3098
value = lines[-1][len(prefix):]
3102
# Controlled by "bzr selftest -E=..." option
3103
selftest_debug_flags = set()
3106
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3108
test_suite_factory=None,
3111
matching_tests_first=None,
3114
exclude_pattern=None,
3120
suite_decorators=None,
3122
"""Run the whole test suite under the enhanced runner"""
3123
# XXX: Very ugly way to do this...
3124
# Disable warning about old formats because we don't want it to disturb
3125
# any blackbox tests.
3126
from bzrlib import repository
3127
repository._deprecation_warning_done = True
3129
global default_transport
3130
if transport is None:
3131
transport = default_transport
3132
old_transport = default_transport
3133
default_transport = transport
3134
global selftest_debug_flags
3135
old_debug_flags = selftest_debug_flags
3136
if debug_flags is not None:
3137
selftest_debug_flags = set(debug_flags)
3139
if load_list is None:
3142
keep_only = load_test_id_list(load_list)
3143
if test_suite_factory is None:
3144
suite = test_suite(keep_only, starting_with)
3146
suite = test_suite_factory()
3147
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3148
stop_on_failure=stop_on_failure,
3149
transport=transport,
3150
lsprof_timed=lsprof_timed,
3151
bench_history=bench_history,
3152
matching_tests_first=matching_tests_first,
3153
list_only=list_only,
3154
random_seed=random_seed,
3155
exclude_pattern=exclude_pattern,
3157
runner_class=runner_class,
3158
suite_decorators=suite_decorators,
3161
default_transport = old_transport
3162
selftest_debug_flags = old_debug_flags
3165
def load_test_id_list(file_name):
3166
"""Load a test id list from a text file.
3168
The format is one test id by line. No special care is taken to impose
3169
strict rules, these test ids are used to filter the test suite so a test id
3170
that do not match an existing test will do no harm. This allows user to add
3171
comments, leave blank lines, etc.
3175
ftest = open(file_name, 'rt')
3177
if e.errno != errno.ENOENT:
3180
raise errors.NoSuchFile(file_name)
3182
for test_name in ftest.readlines():
3183
test_list.append(test_name.strip())
3188
def suite_matches_id_list(test_suite, id_list):
3189
"""Warns about tests not appearing or appearing more than once.
3191
:param test_suite: A TestSuite object.
3192
:param test_id_list: The list of test ids that should be found in
3195
:return: (absents, duplicates) absents is a list containing the test found
3196
in id_list but not in test_suite, duplicates is a list containing the
3197
test found multiple times in test_suite.
3199
When using a prefined test id list, it may occurs that some tests do not
3200
exist anymore or that some tests use the same id. This function warns the
3201
tester about potential problems in his workflow (test lists are volatile)
3202
or in the test suite itself (using the same id for several tests does not
3203
help to localize defects).
3205
# Build a dict counting id occurrences
3207
for test in iter_suite_tests(test_suite):
3209
tests[id] = tests.get(id, 0) + 1
3214
occurs = tests.get(id, 0)
3216
not_found.append(id)
3218
duplicates.append(id)
3220
return not_found, duplicates
3223
class TestIdList(object):
3224
"""Test id list to filter a test suite.
3226
Relying on the assumption that test ids are built as:
3227
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3228
notation, this class offers methods to :
3229
- avoid building a test suite for modules not refered to in the test list,
3230
- keep only the tests listed from the module test suite.
3233
def __init__(self, test_id_list):
3234
# When a test suite needs to be filtered against us we compare test ids
3235
# for equality, so a simple dict offers a quick and simple solution.
3236
self.tests = dict().fromkeys(test_id_list, True)
3238
# While unittest.TestCase have ids like:
3239
# <module>.<class>.<method>[(<param+)],
3240
# doctest.DocTestCase can have ids like:
3243
# <module>.<function>
3244
# <module>.<class>.<method>
3246
# Since we can't predict a test class from its name only, we settle on
3247
# a simple constraint: a test id always begins with its module name.
3250
for test_id in test_id_list:
3251
parts = test_id.split('.')
3252
mod_name = parts.pop(0)
3253
modules[mod_name] = True
3255
mod_name += '.' + part
3256
modules[mod_name] = True
3257
self.modules = modules
3259
def refers_to(self, module_name):
3260
"""Is there tests for the module or one of its sub modules."""
3261
return self.modules.has_key(module_name)
3263
def includes(self, test_id):
3264
return self.tests.has_key(test_id)
3267
class TestPrefixAliasRegistry(registry.Registry):
3268
"""A registry for test prefix aliases.
3270
This helps implement shorcuts for the --starting-with selftest
3271
option. Overriding existing prefixes is not allowed but not fatal (a
3272
warning will be emitted).
3275
def register(self, key, obj, help=None, info=None,
3276
override_existing=False):
3277
"""See Registry.register.
3279
Trying to override an existing alias causes a warning to be emitted,
3280
not a fatal execption.
3283
super(TestPrefixAliasRegistry, self).register(
3284
key, obj, help=help, info=info, override_existing=False)
3286
actual = self.get(key)
3287
note('Test prefix alias %s is already used for %s, ignoring %s'
3288
% (key, actual, obj))
3290
def resolve_alias(self, id_start):
3291
"""Replace the alias by the prefix in the given string.
3293
Using an unknown prefix is an error to help catching typos.
3295
parts = id_start.split('.')
3297
parts[0] = self.get(parts[0])
3299
raise errors.BzrCommandError(
3300
'%s is not a known test prefix alias' % parts[0])
3301
return '.'.join(parts)
3304
test_prefix_alias_registry = TestPrefixAliasRegistry()
3305
"""Registry of test prefix aliases."""
3308
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3309
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3310
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3312
# Obvious higest levels prefixes, feel free to add your own via a plugin
3313
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3314
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3315
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3316
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3317
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3320
def test_suite(keep_only=None, starting_with=None):
3321
"""Build and return TestSuite for the whole of bzrlib.
3323
:param keep_only: A list of test ids limiting the suite returned.
3325
:param starting_with: An id limiting the suite returned to the tests
3328
This function can be replaced if you need to change the default test
3329
suite on a global basis, but it is not encouraged.
3333
'bzrlib.tests.blackbox',
3334
'bzrlib.tests.branch_implementations',
3335
'bzrlib.tests.bzrdir_implementations',
3336
'bzrlib.tests.commands',
3337
'bzrlib.tests.interrepository_implementations',
3338
'bzrlib.tests.intertree_implementations',
3339
'bzrlib.tests.inventory_implementations',
3340
'bzrlib.tests.per_interbranch',
3341
'bzrlib.tests.per_lock',
3342
'bzrlib.tests.per_repository',
3343
'bzrlib.tests.per_repository_chk',
3344
'bzrlib.tests.per_repository_reference',
3345
'bzrlib.tests.test__chk_map',
3346
'bzrlib.tests.test__dirstate_helpers',
3347
'bzrlib.tests.test__groupcompress',
3348
'bzrlib.tests.test__walkdirs_win32',
3349
'bzrlib.tests.test_ancestry',
3350
'bzrlib.tests.test_annotate',
3351
'bzrlib.tests.test_api',
3352
'bzrlib.tests.test_atomicfile',
3353
'bzrlib.tests.test_bad_files',
3354
'bzrlib.tests.test_bisect_multi',
3355
'bzrlib.tests.test_branch',
3356
'bzrlib.tests.test_branchbuilder',
3357
'bzrlib.tests.test_btree_index',
3358
'bzrlib.tests.test_bugtracker',
3359
'bzrlib.tests.test_bundle',
3360
'bzrlib.tests.test_bzrdir',
3361
'bzrlib.tests.test__chunks_to_lines',
3362
'bzrlib.tests.test_cache_utf8',
3363
'bzrlib.tests.test_chk_map',
3364
'bzrlib.tests.test_chunk_writer',
3365
'bzrlib.tests.test_clean_tree',
3366
'bzrlib.tests.test_commands',
3367
'bzrlib.tests.test_commit',
3368
'bzrlib.tests.test_commit_merge',
3369
'bzrlib.tests.test_config',
3370
'bzrlib.tests.test_conflicts',
3371
'bzrlib.tests.test_counted_lock',
3372
'bzrlib.tests.test_decorators',
3373
'bzrlib.tests.test_delta',
3374
'bzrlib.tests.test_debug',
3375
'bzrlib.tests.test_deprecated_graph',
3376
'bzrlib.tests.test_diff',
3377
'bzrlib.tests.test_directory_service',
3378
'bzrlib.tests.test_dirstate',
3379
'bzrlib.tests.test_email_message',
3380
'bzrlib.tests.test_eol_filters',
3381
'bzrlib.tests.test_errors',
3382
'bzrlib.tests.test_export',
3383
'bzrlib.tests.test_extract',
3384
'bzrlib.tests.test_fetch',
3385
'bzrlib.tests.test_fifo_cache',
3386
'bzrlib.tests.test_filters',
3387
'bzrlib.tests.test_ftp_transport',
3388
'bzrlib.tests.test_foreign',
3389
'bzrlib.tests.test_generate_docs',
3390
'bzrlib.tests.test_generate_ids',
3391
'bzrlib.tests.test_globbing',
3392
'bzrlib.tests.test_gpg',
3393
'bzrlib.tests.test_graph',
3394
'bzrlib.tests.test_groupcompress',
3395
'bzrlib.tests.test_hashcache',
3396
'bzrlib.tests.test_help',
3397
'bzrlib.tests.test_hooks',
3398
'bzrlib.tests.test_http',
3399
'bzrlib.tests.test_http_implementations',
3400
'bzrlib.tests.test_http_response',
3401
'bzrlib.tests.test_https_ca_bundle',
3402
'bzrlib.tests.test_identitymap',
3403
'bzrlib.tests.test_ignores',
3404
'bzrlib.tests.test_index',
3405
'bzrlib.tests.test_info',
3406
'bzrlib.tests.test_inv',
3407
'bzrlib.tests.test_inventory_delta',
3408
'bzrlib.tests.test_knit',
3409
'bzrlib.tests.test_lazy_import',
3410
'bzrlib.tests.test_lazy_regex',
3411
'bzrlib.tests.test_lockable_files',
3412
'bzrlib.tests.test_lockdir',
3413
'bzrlib.tests.test_log',
3414
'bzrlib.tests.test_lru_cache',
3415
'bzrlib.tests.test_lsprof',
3416
'bzrlib.tests.test_mail_client',
3417
'bzrlib.tests.test_memorytree',
3418
'bzrlib.tests.test_merge',
3419
'bzrlib.tests.test_merge3',
3420
'bzrlib.tests.test_merge_core',
3421
'bzrlib.tests.test_merge_directive',
3422
'bzrlib.tests.test_missing',
3423
'bzrlib.tests.test_msgeditor',
3424
'bzrlib.tests.test_multiparent',
3425
'bzrlib.tests.test_mutabletree',
3426
'bzrlib.tests.test_nonascii',
3427
'bzrlib.tests.test_options',
3428
'bzrlib.tests.test_osutils',
3429
'bzrlib.tests.test_osutils_encodings',
3430
'bzrlib.tests.test_pack',
3431
'bzrlib.tests.test_pack_repository',
3432
'bzrlib.tests.test_patch',
3433
'bzrlib.tests.test_patches',
3434
'bzrlib.tests.test_permissions',
3435
'bzrlib.tests.test_plugins',
3436
'bzrlib.tests.test_progress',
3437
'bzrlib.tests.test_read_bundle',
3438
'bzrlib.tests.test_reconcile',
3439
'bzrlib.tests.test_reconfigure',
3440
'bzrlib.tests.test_registry',
3441
'bzrlib.tests.test_remote',
3442
'bzrlib.tests.test_rename_map',
3443
'bzrlib.tests.test_repository',
3444
'bzrlib.tests.test_revert',
3445
'bzrlib.tests.test_revision',
3446
'bzrlib.tests.test_revisionspec',
3447
'bzrlib.tests.test_revisiontree',
3448
'bzrlib.tests.test_rio',
3449
'bzrlib.tests.test_rules',
3450
'bzrlib.tests.test_sampler',
3451
'bzrlib.tests.test_selftest',
3452
'bzrlib.tests.test_serializer',
3453
'bzrlib.tests.test_setup',
3454
'bzrlib.tests.test_sftp_transport',
3455
'bzrlib.tests.test_shelf',
3456
'bzrlib.tests.test_shelf_ui',
3457
'bzrlib.tests.test_smart',
3458
'bzrlib.tests.test_smart_add',
3459
'bzrlib.tests.test_smart_request',
3460
'bzrlib.tests.test_smart_transport',
3461
'bzrlib.tests.test_smtp_connection',
3462
'bzrlib.tests.test_source',
3463
'bzrlib.tests.test_ssh_transport',
3464
'bzrlib.tests.test_status',
3465
'bzrlib.tests.test_store',
3466
'bzrlib.tests.test_strace',
3467
'bzrlib.tests.test_subsume',
3468
'bzrlib.tests.test_switch',
3469
'bzrlib.tests.test_symbol_versioning',
3470
'bzrlib.tests.test_tag',
3471
'bzrlib.tests.test_testament',
3472
'bzrlib.tests.test_textfile',
3473
'bzrlib.tests.test_textmerge',
3474
'bzrlib.tests.test_timestamp',
3475
'bzrlib.tests.test_trace',
3476
'bzrlib.tests.test_transactions',
3477
'bzrlib.tests.test_transform',
3478
'bzrlib.tests.test_transport',
3479
'bzrlib.tests.test_transport_implementations',
3480
'bzrlib.tests.test_transport_log',
3481
'bzrlib.tests.test_tree',
3482
'bzrlib.tests.test_treebuilder',
3483
'bzrlib.tests.test_tsort',
3484
'bzrlib.tests.test_tuned_gzip',
3485
'bzrlib.tests.test_ui',
3486
'bzrlib.tests.test_uncommit',
3487
'bzrlib.tests.test_upgrade',
3488
'bzrlib.tests.test_upgrade_stacked',
3489
'bzrlib.tests.test_urlutils',
3490
'bzrlib.tests.test_version',
3491
'bzrlib.tests.test_version_info',
3492
'bzrlib.tests.test_versionedfile',
3493
'bzrlib.tests.test_weave',
3494
'bzrlib.tests.test_whitebox',
3495
'bzrlib.tests.test_win32utils',
3496
'bzrlib.tests.test_workingtree',
3497
'bzrlib.tests.test_workingtree_4',
3498
'bzrlib.tests.test_wsgi',
3499
'bzrlib.tests.test_xml',
3500
'bzrlib.tests.tree_implementations',
3501
'bzrlib.tests.workingtree_implementations',
3502
'bzrlib.util.tests.test_bencode',
3505
loader = TestUtil.TestLoader()
3508
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3509
for start in starting_with]
3510
# We take precedence over keep_only because *at loading time* using
3511
# both options means we will load less tests for the same final result.
3512
def interesting_module(name):
3513
for start in starting_with:
3515
# Either the module name starts with the specified string
3516
name.startswith(start)
3517
# or it may contain tests starting with the specified string
3518
or start.startswith(name)
3522
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3524
elif keep_only is not None:
3525
id_filter = TestIdList(keep_only)
3526
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3527
def interesting_module(name):
3528
return id_filter.refers_to(name)
3531
loader = TestUtil.TestLoader()
3532
def interesting_module(name):
3533
# No filtering, all modules are interesting
3536
suite = loader.suiteClass()
3538
# modules building their suite with loadTestsFromModuleNames
3539
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3541
modules_to_doctest = [
3543
'bzrlib.branchbuilder',
3546
'bzrlib.iterablefile',
3550
'bzrlib.symbol_versioning',
3553
'bzrlib.version_info_formats.format_custom',
3556
for mod in modules_to_doctest:
3557
if not interesting_module(mod):
3558
# No tests to keep here, move along
3561
# note that this really does mean "report only" -- doctest
3562
# still runs the rest of the examples
3563
doc_suite = doctest.DocTestSuite(mod,
3564
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3565
except ValueError, e:
3566
print '**failed to get doctest for: %s\n%s' % (mod, e)
3568
if len(doc_suite._tests) == 0:
3569
raise errors.BzrError("no doctests found in %s" % (mod,))
3570
suite.addTest(doc_suite)
3572
default_encoding = sys.getdefaultencoding()
3573
for name, plugin in bzrlib.plugin.plugins().items():
3574
if not interesting_module(plugin.module.__name__):
3576
plugin_suite = plugin.test_suite()
3577
# We used to catch ImportError here and turn it into just a warning,
3578
# but really if you don't have --no-plugins this should be a failure.
3579
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3580
if plugin_suite is None:
3581
plugin_suite = plugin.load_plugin_tests(loader)
3582
if plugin_suite is not None:
3583
suite.addTest(plugin_suite)
3584
if default_encoding != sys.getdefaultencoding():
3585
bzrlib.trace.warning(
3586
'Plugin "%s" tried to reset default encoding to: %s', name,
3587
sys.getdefaultencoding())
3589
sys.setdefaultencoding(default_encoding)
3592
suite = filter_suite_by_id_startswith(suite, starting_with)
3594
if keep_only is not None:
3595
# Now that the referred modules have loaded their tests, keep only the
3597
suite = filter_suite_by_id_list(suite, id_filter)
3598
# Do some sanity checks on the id_list filtering
3599
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3601
# The tester has used both keep_only and starting_with, so he is
3602
# already aware that some tests are excluded from the list, there
3603
# is no need to tell him which.
3606
# Some tests mentioned in the list are not in the test suite. The
3607
# list may be out of date, report to the tester.
3608
for id in not_found:
3609
bzrlib.trace.warning('"%s" not found in the test suite', id)
3610
for id in duplicates:
3611
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3616
def multiply_scenarios(scenarios_left, scenarios_right):
3617
"""Multiply two sets of scenarios.
3619
:returns: the cartesian product of the two sets of scenarios, that is
3620
a scenario for every possible combination of a left scenario and a
3624
('%s,%s' % (left_name, right_name),
3625
dict(left_dict.items() + right_dict.items()))
3626
for left_name, left_dict in scenarios_left
3627
for right_name, right_dict in scenarios_right]
3630
def multiply_tests(tests, scenarios, result):
3631
"""Multiply tests_list by scenarios into result.
3633
This is the core workhorse for test parameterisation.
3635
Typically the load_tests() method for a per-implementation test suite will
3636
call multiply_tests and return the result.
3638
:param tests: The tests to parameterise.
3639
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3640
scenario_param_dict).
3641
:param result: A TestSuite to add created tests to.
3643
This returns the passed in result TestSuite with the cross product of all
3644
the tests repeated once for each scenario. Each test is adapted by adding
3645
the scenario name at the end of its id(), and updating the test object's
3646
__dict__ with the scenario_param_dict.
3648
>>> import bzrlib.tests.test_sampler
3649
>>> r = multiply_tests(
3650
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3651
... [('one', dict(param=1)),
3652
... ('two', dict(param=2))],
3654
>>> tests = list(iter_suite_tests(r))
3658
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3664
for test in iter_suite_tests(tests):
3665
apply_scenarios(test, scenarios, result)
3669
def apply_scenarios(test, scenarios, result):
3670
"""Apply the scenarios in scenarios to test and add to result.
3672
:param test: The test to apply scenarios to.
3673
:param scenarios: An iterable of scenarios to apply to test.
3675
:seealso: apply_scenario
3677
for scenario in scenarios:
3678
result.addTest(apply_scenario(test, scenario))
3682
def apply_scenario(test, scenario):
3683
"""Copy test and apply scenario to it.
3685
:param test: A test to adapt.
3686
:param scenario: A tuple describing the scenarion.
3687
The first element of the tuple is the new test id.
3688
The second element is a dict containing attributes to set on the
3690
:return: The adapted test.
3692
new_id = "%s(%s)" % (test.id(), scenario[0])
3693
new_test = clone_test(test, new_id)
3694
for name, value in scenario[1].items():
3695
setattr(new_test, name, value)
3699
def clone_test(test, new_id):
3700
"""Clone a test giving it a new id.
3702
:param test: The test to clone.
3703
:param new_id: The id to assign to it.
3704
:return: The new test.
3706
from copy import deepcopy
3707
new_test = deepcopy(test)
3708
new_test.id = lambda: new_id
3712
def _rmtree_temp_dir(dirname):
3713
# If LANG=C we probably have created some bogus paths
3714
# which rmtree(unicode) will fail to delete
3715
# so make sure we are using rmtree(str) to delete everything
3716
# except on win32, where rmtree(str) will fail
3717
# since it doesn't have the property of byte-stream paths
3718
# (they are either ascii or mbcs)
3719
if sys.platform == 'win32':
3720
# make sure we are using the unicode win32 api
3721
dirname = unicode(dirname)
3723
dirname = dirname.encode(sys.getfilesystemencoding())
3725
osutils.rmtree(dirname)
3727
if sys.platform == 'win32' and e.errno == errno.EACCES:
3728
sys.stderr.write('Permission denied: '
3729
'unable to remove testing dir '
3731
% (os.path.basename(dirname), e))
3736
class Feature(object):
3737
"""An operating system Feature."""
3740
self._available = None
3742
def available(self):
3743
"""Is the feature available?
3745
:return: True if the feature is available.
3747
if self._available is None:
3748
self._available = self._probe()
3749
return self._available
3752
"""Implement this method in concrete features.
3754
:return: True if the feature is available.
3756
raise NotImplementedError
3759
if getattr(self, 'feature_name', None):
3760
return self.feature_name()
3761
return self.__class__.__name__
3764
class _SymlinkFeature(Feature):
3767
return osutils.has_symlinks()
3769
def feature_name(self):
3772
SymlinkFeature = _SymlinkFeature()
3775
class _HardlinkFeature(Feature):
3778
return osutils.has_hardlinks()
3780
def feature_name(self):
3783
HardlinkFeature = _HardlinkFeature()
3786
class _OsFifoFeature(Feature):
3789
return getattr(os, 'mkfifo', None)
3791
def feature_name(self):
3792
return 'filesystem fifos'
3794
OsFifoFeature = _OsFifoFeature()
3797
class _UnicodeFilenameFeature(Feature):
3798
"""Does the filesystem support Unicode filenames?"""
3802
# Check for character combinations unlikely to be covered by any
3803
# single non-unicode encoding. We use the characters
3804
# - greek small letter alpha (U+03B1) and
3805
# - braille pattern dots-123456 (U+283F).
3806
os.stat(u'\u03b1\u283f')
3807
except UnicodeEncodeError:
3809
except (IOError, OSError):
3810
# The filesystem allows the Unicode filename but the file doesn't
3814
# The filesystem allows the Unicode filename and the file exists,
3818
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3821
def probe_unicode_in_user_encoding():
3822
"""Try to encode several unicode strings to use in unicode-aware tests.
3823
Return first successfull match.
3825
:return: (unicode value, encoded plain string value) or (None, None)
3827
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3828
for uni_val in possible_vals:
3830
str_val = uni_val.encode(osutils.get_user_encoding())
3831
except UnicodeEncodeError:
3832
# Try a different character
3835
return uni_val, str_val
3839
def probe_bad_non_ascii(encoding):
3840
"""Try to find [bad] character with code [128..255]
3841
that cannot be decoded to unicode in some encoding.
3842
Return None if all non-ascii characters is valid
3845
for i in xrange(128, 256):
3848
char.decode(encoding)
3849
except UnicodeDecodeError:
3854
class _HTTPSServerFeature(Feature):
3855
"""Some tests want an https Server, check if one is available.
3857
Right now, the only way this is available is under python2.6 which provides
3868
def feature_name(self):
3869
return 'HTTPSServer'
3872
HTTPSServerFeature = _HTTPSServerFeature()
3875
class _UnicodeFilename(Feature):
3876
"""Does the filesystem support Unicode filenames?"""
3881
except UnicodeEncodeError:
3883
except (IOError, OSError):
3884
# The filesystem allows the Unicode filename but the file doesn't
3888
# The filesystem allows the Unicode filename and the file exists,
3892
UnicodeFilename = _UnicodeFilename()
3895
class _UTF8Filesystem(Feature):
3896
"""Is the filesystem UTF-8?"""
3899
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3903
UTF8Filesystem = _UTF8Filesystem()
3906
class _CaseInsCasePresFilenameFeature(Feature):
3907
"""Is the file-system case insensitive, but case-preserving?"""
3910
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3912
# first check truly case-preserving for created files, then check
3913
# case insensitive when opening existing files.
3914
name = osutils.normpath(name)
3915
base, rel = osutils.split(name)
3916
found_rel = osutils.canonical_relpath(base, name)
3917
return (found_rel == rel
3918
and os.path.isfile(name.upper())
3919
and os.path.isfile(name.lower()))
3924
def feature_name(self):
3925
return "case-insensitive case-preserving filesystem"
3927
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3930
class _CaseInsensitiveFilesystemFeature(Feature):
3931
"""Check if underlying filesystem is case-insensitive but *not* case
3934
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3935
# more likely to be case preserving, so this case is rare.
3938
if CaseInsCasePresFilenameFeature.available():
3941
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3942
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3943
TestCaseWithMemoryTransport.TEST_ROOT = root
3945
root = TestCaseWithMemoryTransport.TEST_ROOT
3946
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3948
name_a = osutils.pathjoin(tdir, 'a')
3949
name_A = osutils.pathjoin(tdir, 'A')
3951
result = osutils.isdir(name_A)
3952
_rmtree_temp_dir(tdir)
3955
def feature_name(self):
3956
return 'case-insensitive filesystem'
3958
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3961
class _SubUnitFeature(Feature):
3962
"""Check if subunit is available."""
3971
def feature_name(self):
3974
SubUnitFeature = _SubUnitFeature()
3975
# Only define SubUnitBzrRunner if subunit is available.
3977
from subunit import TestProtocolClient
3978
class SubUnitBzrRunner(TextTestRunner):
3979
def run(self, test):
3980
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
