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
802
# Track locks - needs to be called before _clear_debug_flags.
804
self._clear_debug_flags()
805
TestCase._active_threads = threading.activeCount()
806
self.addCleanup(self._check_leaked_threads)
811
pdb.Pdb().set_trace(sys._getframe().f_back)
813
def _check_leaked_threads(self):
814
active = threading.activeCount()
815
leaked_threads = active - TestCase._active_threads
816
TestCase._active_threads = active
818
TestCase._leaking_threads_tests += 1
819
if TestCase._first_thread_leaker_id is None:
820
TestCase._first_thread_leaker_id = self.id()
822
def _clear_debug_flags(self):
823
"""Prevent externally set debug flags affecting tests.
825
Tests that want to use debug flags can just set them in the
826
debug_flags set during setup/teardown.
828
self._preserved_debug_flags = set(debug.debug_flags)
829
if 'allow_debug' not in selftest_debug_flags:
830
debug.debug_flags.clear()
831
self.addCleanup(self._restore_debug_flags)
833
def _clear_hooks(self):
834
# prevent hooks affecting tests
835
self._preserved_hooks = {}
836
for key, factory in hooks.known_hooks.items():
837
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
838
current_hooks = hooks.known_hooks_key_to_object(key)
839
self._preserved_hooks[parent] = (name, current_hooks)
840
self.addCleanup(self._restoreHooks)
841
for key, factory in hooks.known_hooks.items():
842
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
843
setattr(parent, name, factory())
844
# this hook should always be installed
845
request._install_hook()
847
def _silenceUI(self):
848
"""Turn off UI for duration of test"""
849
# by default the UI is off; tests can turn it on if they want it.
850
saved = ui.ui_factory
852
ui.ui_factory = saved
853
ui.ui_factory = ui.SilentUIFactory()
854
self.addCleanup(_restore)
856
def _check_locks(self):
857
"""Check that all lock take/release actions have been paired."""
858
# once we have fixed all the current lock problems, we can change the
859
# following code to always check for mismatched locks, but only do
860
# traceback showing with -Dlock (self._lock_check_thorough is True).
861
# For now, because the test suite will fail, we only assert that lock
862
# matching has occured with -Dlock.
864
acquired_locks = [lock for action, lock in self._lock_actions
865
if action == 'acquired']
866
released_locks = [lock for action, lock in self._lock_actions
867
if action == 'released']
868
# trivially, given the tests for lock acquistion and release, if we
869
# have as many in each list, it should be ok.
870
if len(acquired_locks) != len(released_locks):
872
("Different number of acquired and released locks. (%s, %s)" %
873
(acquired_locks, released_locks))
874
if not self._lock_check_thorough:
875
# Rather than fail, just warn
876
print "Broken test %s: %s" % (self, message)
880
def _track_locks(self):
881
"""Track lock activity during tests."""
882
self._lock_actions = []
883
self._lock_check_thorough = 'lock' in debug.debug_flags
884
self.addCleanup(self._check_locks)
885
_mod_lock.Lock.hooks.install_named_hook('lock_acquired', self._lock_acquired, None)
886
_mod_lock.Lock.hooks.install_named_hook('lock_released', self._lock_released, None)
888
def _lock_acquired(self, result):
889
self._lock_actions.append(('acquired', result))
891
def _lock_released(self, result):
892
self._lock_actions.append(('released', result))
894
def _ndiff_strings(self, a, b):
895
"""Return ndiff between two strings containing lines.
897
A trailing newline is added if missing to make the strings
899
if b and b[-1] != '\n':
901
if a and a[-1] != '\n':
903
difflines = difflib.ndiff(a.splitlines(True),
905
linejunk=lambda x: False,
906
charjunk=lambda x: False)
907
return ''.join(difflines)
909
def assertEqual(self, a, b, message=''):
913
except UnicodeError, e:
914
# If we can't compare without getting a UnicodeError, then
915
# obviously they are different
916
mutter('UnicodeError: %s', e)
919
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
921
pformat(a), pformat(b)))
923
assertEquals = assertEqual
925
def assertEqualDiff(self, a, b, message=None):
926
"""Assert two texts are equal, if not raise an exception.
928
This is intended for use with multi-line strings where it can
929
be hard to find the differences by eye.
931
# TODO: perhaps override assertEquals to call this for strings?
935
message = "texts not equal:\n"
937
message = 'first string is missing a final newline.\n'
939
message = 'second string is missing a final newline.\n'
940
raise AssertionError(message +
941
self._ndiff_strings(a, b))
943
def assertEqualMode(self, mode, mode_test):
944
self.assertEqual(mode, mode_test,
945
'mode mismatch %o != %o' % (mode, mode_test))
947
def assertEqualStat(self, expected, actual):
948
"""assert that expected and actual are the same stat result.
950
:param expected: A stat result.
951
:param actual: A stat result.
952
:raises AssertionError: If the expected and actual stat values differ
955
self.assertEqual(expected.st_size, actual.st_size)
956
self.assertEqual(expected.st_mtime, actual.st_mtime)
957
self.assertEqual(expected.st_ctime, actual.st_ctime)
958
self.assertEqual(expected.st_dev, actual.st_dev)
959
self.assertEqual(expected.st_ino, actual.st_ino)
960
self.assertEqual(expected.st_mode, actual.st_mode)
962
def assertLength(self, length, obj_with_len):
963
"""Assert that obj_with_len is of length length."""
964
if len(obj_with_len) != length:
965
self.fail("Incorrect length: wanted %d, got %d for %r" % (
966
length, len(obj_with_len), obj_with_len))
968
def assertPositive(self, val):
969
"""Assert that val is greater than 0."""
970
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
972
def assertNegative(self, val):
973
"""Assert that val is less than 0."""
974
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
976
def assertStartsWith(self, s, prefix):
977
if not s.startswith(prefix):
978
raise AssertionError('string %r does not start with %r' % (s, prefix))
980
def assertEndsWith(self, s, suffix):
981
"""Asserts that s ends with suffix."""
982
if not s.endswith(suffix):
983
raise AssertionError('string %r does not end with %r' % (s, suffix))
985
def assertContainsRe(self, haystack, needle_re, flags=0):
986
"""Assert that a contains something matching a regular expression."""
987
if not re.search(needle_re, haystack, flags):
988
if '\n' in haystack or len(haystack) > 60:
989
# a long string, format it in a more readable way
990
raise AssertionError(
991
'pattern "%s" not found in\n"""\\\n%s"""\n'
992
% (needle_re, haystack))
994
raise AssertionError('pattern "%s" not found in "%s"'
995
% (needle_re, haystack))
997
def assertNotContainsRe(self, haystack, needle_re, flags=0):
998
"""Assert that a does not match a regular expression"""
999
if re.search(needle_re, haystack, flags):
1000
raise AssertionError('pattern "%s" found in "%s"'
1001
% (needle_re, haystack))
1003
def assertSubset(self, sublist, superlist):
1004
"""Assert that every entry in sublist is present in superlist."""
1005
missing = set(sublist) - set(superlist)
1006
if len(missing) > 0:
1007
raise AssertionError("value(s) %r not present in container %r" %
1008
(missing, superlist))
1010
def assertListRaises(self, excClass, func, *args, **kwargs):
1011
"""Fail unless excClass is raised when the iterator from func is used.
1013
Many functions can return generators this makes sure
1014
to wrap them in a list() call to make sure the whole generator
1015
is run, and that the proper exception is raised.
1018
list(func(*args, **kwargs))
1022
if getattr(excClass,'__name__', None) is not None:
1023
excName = excClass.__name__
1025
excName = str(excClass)
1026
raise self.failureException, "%s not raised" % excName
1028
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1029
"""Assert that a callable raises a particular exception.
1031
:param excClass: As for the except statement, this may be either an
1032
exception class, or a tuple of classes.
1033
:param callableObj: A callable, will be passed ``*args`` and
1036
Returns the exception so that you can examine it.
1039
callableObj(*args, **kwargs)
1043
if getattr(excClass,'__name__', None) is not None:
1044
excName = excClass.__name__
1047
excName = str(excClass)
1048
raise self.failureException, "%s not raised" % excName
1050
def assertIs(self, left, right, message=None):
1051
if not (left is right):
1052
if message is not None:
1053
raise AssertionError(message)
1055
raise AssertionError("%r is not %r." % (left, right))
1057
def assertIsNot(self, left, right, message=None):
1059
if message is not None:
1060
raise AssertionError(message)
1062
raise AssertionError("%r is %r." % (left, right))
1064
def assertTransportMode(self, transport, path, mode):
1065
"""Fail if a path does not have mode "mode".
1067
If modes are not supported on this transport, the assertion is ignored.
1069
if not transport._can_roundtrip_unix_modebits():
1071
path_stat = transport.stat(path)
1072
actual_mode = stat.S_IMODE(path_stat.st_mode)
1073
self.assertEqual(mode, actual_mode,
1074
'mode of %r incorrect (%s != %s)'
1075
% (path, oct(mode), oct(actual_mode)))
1077
def assertIsSameRealPath(self, path1, path2):
1078
"""Fail if path1 and path2 points to different files"""
1079
self.assertEqual(osutils.realpath(path1),
1080
osutils.realpath(path2),
1081
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1083
def assertIsInstance(self, obj, kls):
1084
"""Fail if obj is not an instance of kls"""
1085
if not isinstance(obj, kls):
1086
self.fail("%r is an instance of %s rather than %s" % (
1087
obj, obj.__class__, kls))
1089
def expectFailure(self, reason, assertion, *args, **kwargs):
1090
"""Invoke a test, expecting it to fail for the given reason.
1092
This is for assertions that ought to succeed, but currently fail.
1093
(The failure is *expected* but not *wanted*.) Please be very precise
1094
about the failure you're expecting. If a new bug is introduced,
1095
AssertionError should be raised, not KnownFailure.
1097
Frequently, expectFailure should be followed by an opposite assertion.
1100
Intended to be used with a callable that raises AssertionError as the
1101
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1103
Raises KnownFailure if the test fails. Raises AssertionError if the
1108
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1110
self.assertEqual(42, dynamic_val)
1112
This means that a dynamic_val of 54 will cause the test to raise
1113
a KnownFailure. Once math is fixed and the expectFailure is removed,
1114
only a dynamic_val of 42 will allow the test to pass. Anything other
1115
than 54 or 42 will cause an AssertionError.
1118
assertion(*args, **kwargs)
1119
except AssertionError:
1120
raise KnownFailure(reason)
1122
self.fail('Unexpected success. Should have failed: %s' % reason)
1124
def assertFileEqual(self, content, path):
1125
"""Fail if path does not contain 'content'."""
1126
self.failUnlessExists(path)
1127
f = file(path, 'rb')
1132
self.assertEqualDiff(content, s)
1134
def failUnlessExists(self, path):
1135
"""Fail unless path or paths, which may be abs or relative, exist."""
1136
if not isinstance(path, basestring):
1138
self.failUnlessExists(p)
1140
self.failUnless(osutils.lexists(path),path+" does not exist")
1142
def failIfExists(self, path):
1143
"""Fail if path or paths, which may be abs or relative, exist."""
1144
if not isinstance(path, basestring):
1146
self.failIfExists(p)
1148
self.failIf(osutils.lexists(path),path+" exists")
1150
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1151
"""A helper for callDeprecated and applyDeprecated.
1153
:param a_callable: A callable to call.
1154
:param args: The positional arguments for the callable
1155
:param kwargs: The keyword arguments for the callable
1156
:return: A tuple (warnings, result). result is the result of calling
1157
a_callable(``*args``, ``**kwargs``).
1160
def capture_warnings(msg, cls=None, stacklevel=None):
1161
# we've hooked into a deprecation specific callpath,
1162
# only deprecations should getting sent via it.
1163
self.assertEqual(cls, DeprecationWarning)
1164
local_warnings.append(msg)
1165
original_warning_method = symbol_versioning.warn
1166
symbol_versioning.set_warning_method(capture_warnings)
1168
result = a_callable(*args, **kwargs)
1170
symbol_versioning.set_warning_method(original_warning_method)
1171
return (local_warnings, result)
1173
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1174
"""Call a deprecated callable without warning the user.
1176
Note that this only captures warnings raised by symbol_versioning.warn,
1177
not other callers that go direct to the warning module.
1179
To test that a deprecated method raises an error, do something like
1182
self.assertRaises(errors.ReservedId,
1183
self.applyDeprecated,
1184
deprecated_in((1, 5, 0)),
1188
:param deprecation_format: The deprecation format that the callable
1189
should have been deprecated with. This is the same type as the
1190
parameter to deprecated_method/deprecated_function. If the
1191
callable is not deprecated with this format, an assertion error
1193
:param a_callable: A callable to call. This may be a bound method or
1194
a regular function. It will be called with ``*args`` and
1196
:param args: The positional arguments for the callable
1197
:param kwargs: The keyword arguments for the callable
1198
:return: The result of a_callable(``*args``, ``**kwargs``)
1200
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1202
expected_first_warning = symbol_versioning.deprecation_string(
1203
a_callable, deprecation_format)
1204
if len(call_warnings) == 0:
1205
self.fail("No deprecation warning generated by call to %s" %
1207
self.assertEqual(expected_first_warning, call_warnings[0])
1210
def callCatchWarnings(self, fn, *args, **kw):
1211
"""Call a callable that raises python warnings.
1213
The caller's responsible for examining the returned warnings.
1215
If the callable raises an exception, the exception is not
1216
caught and propagates up to the caller. In that case, the list
1217
of warnings is not available.
1219
:returns: ([warning_object, ...], fn_result)
1221
# XXX: This is not perfect, because it completely overrides the
1222
# warnings filters, and some code may depend on suppressing particular
1223
# warnings. It's the easiest way to insulate ourselves from -Werror,
1224
# though. -- Andrew, 20071062
1226
def _catcher(message, category, filename, lineno, file=None, line=None):
1227
# despite the name, 'message' is normally(?) a Warning subclass
1229
wlist.append(message)
1230
saved_showwarning = warnings.showwarning
1231
saved_filters = warnings.filters
1233
warnings.showwarning = _catcher
1234
warnings.filters = []
1235
result = fn(*args, **kw)
1237
warnings.showwarning = saved_showwarning
1238
warnings.filters = saved_filters
1239
return wlist, result
1241
def callDeprecated(self, expected, callable, *args, **kwargs):
1242
"""Assert that a callable is deprecated in a particular way.
1244
This is a very precise test for unusual requirements. The
1245
applyDeprecated helper function is probably more suited for most tests
1246
as it allows you to simply specify the deprecation format being used
1247
and will ensure that that is issued for the function being called.
1249
Note that this only captures warnings raised by symbol_versioning.warn,
1250
not other callers that go direct to the warning module. To catch
1251
general warnings, use callCatchWarnings.
1253
:param expected: a list of the deprecation warnings expected, in order
1254
:param callable: The callable to call
1255
:param args: The positional arguments for the callable
1256
:param kwargs: The keyword arguments for the callable
1258
call_warnings, result = self._capture_deprecation_warnings(callable,
1260
self.assertEqual(expected, call_warnings)
1263
def _startLogFile(self):
1264
"""Send bzr and test log messages to a temporary file.
1266
The file is removed as the test is torn down.
1268
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1269
self._log_file = os.fdopen(fileno, 'w+')
1270
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1271
self._log_file_name = name
1272
self.addCleanup(self._finishLogFile)
1274
def _finishLogFile(self):
1275
"""Finished with the log file.
1277
Close the file and delete it, unless setKeepLogfile was called.
1279
if self._log_file is None:
1281
bzrlib.trace.pop_log_file(self._log_memento)
1282
self._log_file.close()
1283
self._log_file = None
1284
if not self._keep_log_file:
1285
os.remove(self._log_file_name)
1286
self._log_file_name = None
1288
def setKeepLogfile(self):
1289
"""Make the logfile not be deleted when _finishLogFile is called."""
1290
self._keep_log_file = True
1292
def addCleanup(self, callable, *args, **kwargs):
1293
"""Arrange to run a callable when this case is torn down.
1295
Callables are run in the reverse of the order they are registered,
1296
ie last-in first-out.
1298
self._cleanups.append((callable, args, kwargs))
1300
def _cleanEnvironment(self):
1302
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1303
'HOME': os.getcwd(),
1304
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1305
# tests do check our impls match APPDATA
1306
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1310
'BZREMAIL': None, # may still be present in the environment
1312
'BZR_PROGRESS_BAR': None,
1314
'BZR_PLUGIN_PATH': None,
1316
'SSH_AUTH_SOCK': None,
1320
'https_proxy': None,
1321
'HTTPS_PROXY': None,
1326
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1327
# least. If you do (care), please update this comment
1331
'BZR_REMOTE_PATH': None,
1334
self.addCleanup(self._restoreEnvironment)
1335
for name, value in new_env.iteritems():
1336
self._captureVar(name, value)
1338
def _captureVar(self, name, newvalue):
1339
"""Set an environment variable, and reset it when finished."""
1340
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1342
def _restore_debug_flags(self):
1343
debug.debug_flags.clear()
1344
debug.debug_flags.update(self._preserved_debug_flags)
1346
def _restoreEnvironment(self):
1347
for name, value in self.__old_env.iteritems():
1348
osutils.set_or_unset_env(name, value)
1350
def _restoreHooks(self):
1351
for klass, (name, hooks) in self._preserved_hooks.items():
1352
setattr(klass, name, hooks)
1354
def knownFailure(self, reason):
1355
"""This test has failed for some known reason."""
1356
raise KnownFailure(reason)
1358
def _do_skip(self, result, reason):
1359
addSkip = getattr(result, 'addSkip', None)
1360
if not callable(addSkip):
1361
result.addError(self, sys.exc_info())
1363
addSkip(self, reason)
1365
def run(self, result=None):
1366
if result is None: result = self.defaultTestResult()
1367
for feature in getattr(self, '_test_needs_features', []):
1368
if not feature.available():
1369
result.startTest(self)
1370
if getattr(result, 'addNotSupported', None):
1371
result.addNotSupported(self, feature)
1373
result.addSuccess(self)
1374
result.stopTest(self)
1378
result.startTest(self)
1379
absent_attr = object()
1381
method_name = getattr(self, '_testMethodName', absent_attr)
1382
if method_name is absent_attr:
1384
method_name = getattr(self, '_TestCase__testMethodName')
1385
testMethod = getattr(self, method_name)
1389
if not self._bzr_test_setUp_run:
1391
"test setUp did not invoke "
1392
"bzrlib.tests.TestCase's setUp")
1393
except KeyboardInterrupt:
1396
except TestSkipped, e:
1397
self._do_skip(result, e.args[0])
1401
result.addError(self, sys.exc_info())
1409
except self.failureException:
1410
result.addFailure(self, sys.exc_info())
1411
except TestSkipped, e:
1413
reason = "No reason given."
1416
self._do_skip(result, reason)
1417
except KeyboardInterrupt:
1421
result.addError(self, sys.exc_info())
1425
if not self._bzr_test_tearDown_run:
1427
"test tearDown did not invoke "
1428
"bzrlib.tests.TestCase's tearDown")
1429
except KeyboardInterrupt:
1433
result.addError(self, sys.exc_info())
1436
if ok: result.addSuccess(self)
1438
result.stopTest(self)
1440
except TestNotApplicable:
1441
# Not moved from the result [yet].
1444
except KeyboardInterrupt:
1449
absent_attr = object()
1450
for attr_name in self.attrs_to_keep:
1451
attr = getattr(self, attr_name, absent_attr)
1452
if attr is not absent_attr:
1453
saved_attrs[attr_name] = attr
1454
self.__dict__ = saved_attrs
1458
self._log_contents = ''
1459
self._bzr_test_tearDown_run = True
1460
unittest.TestCase.tearDown(self)
1462
def time(self, callable, *args, **kwargs):
1463
"""Run callable and accrue the time it takes to the benchmark time.
1465
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1466
this will cause lsprofile statistics to be gathered and stored in
1469
if self._benchtime is None:
1473
if not self._gather_lsprof_in_benchmarks:
1474
return callable(*args, **kwargs)
1476
# record this benchmark
1477
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1479
self._benchcalls.append(((callable, args, kwargs), stats))
1482
self._benchtime += time.time() - start
1484
def _runCleanups(self):
1485
"""Run registered cleanup functions.
1487
This should only be called from TestCase.tearDown.
1489
# TODO: Perhaps this should keep running cleanups even if
1490
# one of them fails?
1492
# Actually pop the cleanups from the list so tearDown running
1493
# twice is safe (this happens for skipped tests).
1494
while self._cleanups:
1495
cleanup, args, kwargs = self._cleanups.pop()
1496
cleanup(*args, **kwargs)
1498
def log(self, *args):
1501
def _get_log(self, keep_log_file=False):
1502
"""Get the log from bzrlib.trace calls from this test.
1504
:param keep_log_file: When True, if the log is still a file on disk
1505
leave it as a file on disk. When False, if the log is still a file
1506
on disk, the log file is deleted and the log preserved as
1508
:return: A string containing the log.
1510
# flush the log file, to get all content
1512
if bzrlib.trace._trace_file:
1513
bzrlib.trace._trace_file.flush()
1514
if self._log_contents:
1515
# XXX: this can hardly contain the content flushed above --vila
1517
return self._log_contents
1518
if self._log_file_name is not None:
1519
logfile = open(self._log_file_name)
1521
log_contents = logfile.read()
1524
if not keep_log_file:
1525
self._log_contents = log_contents
1527
os.remove(self._log_file_name)
1529
if sys.platform == 'win32' and e.errno == errno.EACCES:
1530
sys.stderr.write(('Unable to delete log file '
1531
' %r\n' % self._log_file_name))
1536
return "DELETED log file to reduce memory footprint"
1538
def requireFeature(self, feature):
1539
"""This test requires a specific feature is available.
1541
:raises UnavailableFeature: When feature is not available.
1543
if not feature.available():
1544
raise UnavailableFeature(feature)
1546
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1548
"""Run bazaar command line, splitting up a string command line."""
1549
if isinstance(args, basestring):
1550
# shlex don't understand unicode strings,
1551
# so args should be plain string (bialix 20070906)
1552
args = list(shlex.split(str(args)))
1553
return self._run_bzr_core(args, retcode=retcode,
1554
encoding=encoding, stdin=stdin, working_dir=working_dir,
1557
def _run_bzr_core(self, args, retcode, encoding, stdin,
1559
if encoding is None:
1560
encoding = osutils.get_user_encoding()
1561
stdout = StringIOWrapper()
1562
stderr = StringIOWrapper()
1563
stdout.encoding = encoding
1564
stderr.encoding = encoding
1566
self.log('run bzr: %r', args)
1567
# FIXME: don't call into logging here
1568
handler = logging.StreamHandler(stderr)
1569
handler.setLevel(logging.INFO)
1570
logger = logging.getLogger('')
1571
logger.addHandler(handler)
1572
old_ui_factory = ui.ui_factory
1573
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1576
if working_dir is not None:
1577
cwd = osutils.getcwd()
1578
os.chdir(working_dir)
1581
result = self.apply_redirected(ui.ui_factory.stdin,
1583
bzrlib.commands.run_bzr_catch_user_errors,
1586
logger.removeHandler(handler)
1587
ui.ui_factory = old_ui_factory
1591
out = stdout.getvalue()
1592
err = stderr.getvalue()
1594
self.log('output:\n%r', out)
1596
self.log('errors:\n%r', err)
1597
if retcode is not None:
1598
self.assertEquals(retcode, result,
1599
message='Unexpected return code')
1602
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1603
working_dir=None, error_regexes=[], output_encoding=None):
1604
"""Invoke bzr, as if it were run from the command line.
1606
The argument list should not include the bzr program name - the
1607
first argument is normally the bzr command. Arguments may be
1608
passed in three ways:
1610
1- A list of strings, eg ["commit", "a"]. This is recommended
1611
when the command contains whitespace or metacharacters, or
1612
is built up at run time.
1614
2- A single string, eg "add a". This is the most convenient
1615
for hardcoded commands.
1617
This runs bzr through the interface that catches and reports
1618
errors, and with logging set to something approximating the
1619
default, so that error reporting can be checked.
1621
This should be the main method for tests that want to exercise the
1622
overall behavior of the bzr application (rather than a unit test
1623
or a functional test of the library.)
1625
This sends the stdout/stderr results into the test's log,
1626
where it may be useful for debugging. See also run_captured.
1628
:keyword stdin: A string to be used as stdin for the command.
1629
:keyword retcode: The status code the command should return;
1631
:keyword working_dir: The directory to run the command in
1632
:keyword error_regexes: A list of expected error messages. If
1633
specified they must be seen in the error output of the command.
1635
out, err = self._run_bzr_autosplit(
1640
working_dir=working_dir,
1642
for regex in error_regexes:
1643
self.assertContainsRe(err, regex)
1646
def run_bzr_error(self, error_regexes, *args, **kwargs):
1647
"""Run bzr, and check that stderr contains the supplied regexes
1649
:param error_regexes: Sequence of regular expressions which
1650
must each be found in the error output. The relative ordering
1652
:param args: command-line arguments for bzr
1653
:param kwargs: Keyword arguments which are interpreted by run_bzr
1654
This function changes the default value of retcode to be 3,
1655
since in most cases this is run when you expect bzr to fail.
1657
:return: (out, err) The actual output of running the command (in case
1658
you want to do more inspection)
1662
# Make sure that commit is failing because there is nothing to do
1663
self.run_bzr_error(['no changes to commit'],
1664
['commit', '-m', 'my commit comment'])
1665
# Make sure --strict is handling an unknown file, rather than
1666
# giving us the 'nothing to do' error
1667
self.build_tree(['unknown'])
1668
self.run_bzr_error(['Commit refused because there are unknown files'],
1669
['commit', --strict', '-m', 'my commit comment'])
1671
kwargs.setdefault('retcode', 3)
1672
kwargs['error_regexes'] = error_regexes
1673
out, err = self.run_bzr(*args, **kwargs)
1676
def run_bzr_subprocess(self, *args, **kwargs):
1677
"""Run bzr in a subprocess for testing.
1679
This starts a new Python interpreter and runs bzr in there.
1680
This should only be used for tests that have a justifiable need for
1681
this isolation: e.g. they are testing startup time, or signal
1682
handling, or early startup code, etc. Subprocess code can't be
1683
profiled or debugged so easily.
1685
:keyword retcode: The status code that is expected. Defaults to 0. If
1686
None is supplied, the status code is not checked.
1687
:keyword env_changes: A dictionary which lists changes to environment
1688
variables. A value of None will unset the env variable.
1689
The values must be strings. The change will only occur in the
1690
child, so you don't need to fix the environment after running.
1691
:keyword universal_newlines: Convert CRLF => LF
1692
:keyword allow_plugins: By default the subprocess is run with
1693
--no-plugins to ensure test reproducibility. Also, it is possible
1694
for system-wide plugins to create unexpected output on stderr,
1695
which can cause unnecessary test failures.
1697
env_changes = kwargs.get('env_changes', {})
1698
working_dir = kwargs.get('working_dir', None)
1699
allow_plugins = kwargs.get('allow_plugins', False)
1701
if isinstance(args[0], list):
1703
elif isinstance(args[0], basestring):
1704
args = list(shlex.split(args[0]))
1706
raise ValueError("passing varargs to run_bzr_subprocess")
1707
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1708
working_dir=working_dir,
1709
allow_plugins=allow_plugins)
1710
# We distinguish between retcode=None and retcode not passed.
1711
supplied_retcode = kwargs.get('retcode', 0)
1712
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1713
universal_newlines=kwargs.get('universal_newlines', False),
1716
def start_bzr_subprocess(self, process_args, env_changes=None,
1717
skip_if_plan_to_signal=False,
1719
allow_plugins=False):
1720
"""Start bzr in a subprocess for testing.
1722
This starts a new Python interpreter and runs bzr in there.
1723
This should only be used for tests that have a justifiable need for
1724
this isolation: e.g. they are testing startup time, or signal
1725
handling, or early startup code, etc. Subprocess code can't be
1726
profiled or debugged so easily.
1728
:param process_args: a list of arguments to pass to the bzr executable,
1729
for example ``['--version']``.
1730
:param env_changes: A dictionary which lists changes to environment
1731
variables. A value of None will unset the env variable.
1732
The values must be strings. The change will only occur in the
1733
child, so you don't need to fix the environment after running.
1734
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1736
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1738
:returns: Popen object for the started process.
1740
if skip_if_plan_to_signal:
1741
if not getattr(os, 'kill', None):
1742
raise TestSkipped("os.kill not available.")
1744
if env_changes is None:
1748
def cleanup_environment():
1749
for env_var, value in env_changes.iteritems():
1750
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1752
def restore_environment():
1753
for env_var, value in old_env.iteritems():
1754
osutils.set_or_unset_env(env_var, value)
1756
bzr_path = self.get_bzr_path()
1759
if working_dir is not None:
1760
cwd = osutils.getcwd()
1761
os.chdir(working_dir)
1764
# win32 subprocess doesn't support preexec_fn
1765
# so we will avoid using it on all platforms, just to
1766
# make sure the code path is used, and we don't break on win32
1767
cleanup_environment()
1768
command = [sys.executable]
1769
# frozen executables don't need the path to bzr
1770
if getattr(sys, "frozen", None) is None:
1771
command.append(bzr_path)
1772
if not allow_plugins:
1773
command.append('--no-plugins')
1774
command.extend(process_args)
1775
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1777
restore_environment()
1783
def _popen(self, *args, **kwargs):
1784
"""Place a call to Popen.
1786
Allows tests to override this method to intercept the calls made to
1787
Popen for introspection.
1789
return Popen(*args, **kwargs)
1791
def get_bzr_path(self):
1792
"""Return the path of the 'bzr' executable for this test suite."""
1793
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1794
if not os.path.isfile(bzr_path):
1795
# We are probably installed. Assume sys.argv is the right file
1796
bzr_path = sys.argv[0]
1799
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1800
universal_newlines=False, process_args=None):
1801
"""Finish the execution of process.
1803
:param process: the Popen object returned from start_bzr_subprocess.
1804
:param retcode: The status code that is expected. Defaults to 0. If
1805
None is supplied, the status code is not checked.
1806
:param send_signal: an optional signal to send to the process.
1807
:param universal_newlines: Convert CRLF => LF
1808
:returns: (stdout, stderr)
1810
if send_signal is not None:
1811
os.kill(process.pid, send_signal)
1812
out, err = process.communicate()
1814
if universal_newlines:
1815
out = out.replace('\r\n', '\n')
1816
err = err.replace('\r\n', '\n')
1818
if retcode is not None and retcode != process.returncode:
1819
if process_args is None:
1820
process_args = "(unknown args)"
1821
mutter('Output of bzr %s:\n%s', process_args, out)
1822
mutter('Error for bzr %s:\n%s', process_args, err)
1823
self.fail('Command bzr %s failed with retcode %s != %s'
1824
% (process_args, retcode, process.returncode))
1827
def check_inventory_shape(self, inv, shape):
1828
"""Compare an inventory to a list of expected names.
1830
Fail if they are not precisely equal.
1833
shape = list(shape) # copy
1834
for path, ie in inv.entries():
1835
name = path.replace('\\', '/')
1836
if ie.kind == 'directory':
1843
self.fail("expected paths not found in inventory: %r" % shape)
1845
self.fail("unexpected paths found in inventory: %r" % extras)
1847
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1848
a_callable=None, *args, **kwargs):
1849
"""Call callable with redirected std io pipes.
1851
Returns the return code."""
1852
if not callable(a_callable):
1853
raise ValueError("a_callable must be callable.")
1855
stdin = StringIO("")
1857
if getattr(self, "_log_file", None) is not None:
1858
stdout = self._log_file
1862
if getattr(self, "_log_file", None is not None):
1863
stderr = self._log_file
1866
real_stdin = sys.stdin
1867
real_stdout = sys.stdout
1868
real_stderr = sys.stderr
1873
return a_callable(*args, **kwargs)
1875
sys.stdout = real_stdout
1876
sys.stderr = real_stderr
1877
sys.stdin = real_stdin
1879
def reduceLockdirTimeout(self):
1880
"""Reduce the default lock timeout for the duration of the test, so that
1881
if LockContention occurs during a test, it does so quickly.
1883
Tests that expect to provoke LockContention errors should call this.
1885
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1887
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1888
self.addCleanup(resetTimeout)
1889
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1891
def make_utf8_encoded_stringio(self, encoding_type=None):
1892
"""Return a StringIOWrapper instance, that will encode Unicode
1895
if encoding_type is None:
1896
encoding_type = 'strict'
1898
output_encoding = 'utf-8'
1899
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1900
sio.encoding = output_encoding
1904
class CapturedCall(object):
1905
"""A helper for capturing smart server calls for easy debug analysis."""
1907
def __init__(self, params, prefix_length):
1908
"""Capture the call with params and skip prefix_length stack frames."""
1911
# The last 5 frames are the __init__, the hook frame, and 3 smart
1912
# client frames. Beyond this we could get more clever, but this is good
1914
stack = traceback.extract_stack()[prefix_length:-5]
1915
self.stack = ''.join(traceback.format_list(stack))
1918
return self.call.method
1921
return self.call.method
1927
class TestCaseWithMemoryTransport(TestCase):
1928
"""Common test class for tests that do not need disk resources.
1930
Tests that need disk resources should derive from TestCaseWithTransport.
1932
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1934
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1935
a directory which does not exist. This serves to help ensure test isolation
1936
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1937
must exist. However, TestCaseWithMemoryTransport does not offer local
1938
file defaults for the transport in tests, nor does it obey the command line
1939
override, so tests that accidentally write to the common directory should
1942
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1943
a .bzr directory that stops us ascending higher into the filesystem.
1949
def __init__(self, methodName='runTest'):
1950
# allow test parameterization after test construction and before test
1951
# execution. Variables that the parameterizer sets need to be
1952
# ones that are not set by setUp, or setUp will trash them.
1953
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1954
self.vfs_transport_factory = default_transport
1955
self.transport_server = None
1956
self.transport_readonly_server = None
1957
self.__vfs_server = None
1959
def get_transport(self, relpath=None):
1960
"""Return a writeable transport.
1962
This transport is for the test scratch space relative to
1965
:param relpath: a path relative to the base url.
1967
t = get_transport(self.get_url(relpath))
1968
self.assertFalse(t.is_readonly())
1971
def get_readonly_transport(self, relpath=None):
1972
"""Return a readonly transport for the test scratch space
1974
This can be used to test that operations which should only need
1975
readonly access in fact do not try to write.
1977
:param relpath: a path relative to the base url.
1979
t = get_transport(self.get_readonly_url(relpath))
1980
self.assertTrue(t.is_readonly())
1983
def create_transport_readonly_server(self):
1984
"""Create a transport server from class defined at init.
1986
This is mostly a hook for daughter classes.
1988
return self.transport_readonly_server()
1990
def get_readonly_server(self):
1991
"""Get the server instance for the readonly transport
1993
This is useful for some tests with specific servers to do diagnostics.
1995
if self.__readonly_server is None:
1996
if self.transport_readonly_server is None:
1997
# readonly decorator requested
1998
# bring up the server
1999
self.__readonly_server = ReadonlyServer()
2000
self.__readonly_server.setUp(self.get_vfs_only_server())
2002
self.__readonly_server = self.create_transport_readonly_server()
2003
self.__readonly_server.setUp(self.get_vfs_only_server())
2004
self.addCleanup(self.__readonly_server.tearDown)
2005
return self.__readonly_server
2007
def get_readonly_url(self, relpath=None):
2008
"""Get a URL for the readonly transport.
2010
This will either be backed by '.' or a decorator to the transport
2011
used by self.get_url()
2012
relpath provides for clients to get a path relative to the base url.
2013
These should only be downwards relative, not upwards.
2015
base = self.get_readonly_server().get_url()
2016
return self._adjust_url(base, relpath)
2018
def get_vfs_only_server(self):
2019
"""Get the vfs only read/write server instance.
2021
This is useful for some tests with specific servers that need
2024
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2025
is no means to override it.
2027
if self.__vfs_server is None:
2028
self.__vfs_server = MemoryServer()
2029
self.__vfs_server.setUp()
2030
self.addCleanup(self.__vfs_server.tearDown)
2031
return self.__vfs_server
2033
def get_server(self):
2034
"""Get the read/write server instance.
2036
This is useful for some tests with specific servers that need
2039
This is built from the self.transport_server factory. If that is None,
2040
then the self.get_vfs_server is returned.
2042
if self.__server is None:
2043
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2044
return self.get_vfs_only_server()
2046
# bring up a decorated means of access to the vfs only server.
2047
self.__server = self.transport_server()
2049
self.__server.setUp(self.get_vfs_only_server())
2050
except TypeError, e:
2051
# This should never happen; the try:Except here is to assist
2052
# developers having to update code rather than seeing an
2053
# uninformative TypeError.
2054
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2055
self.addCleanup(self.__server.tearDown)
2056
return self.__server
2058
def _adjust_url(self, base, relpath):
2059
"""Get a URL (or maybe a path) for the readwrite transport.
2061
This will either be backed by '.' or to an equivalent non-file based
2063
relpath provides for clients to get a path relative to the base url.
2064
These should only be downwards relative, not upwards.
2066
if relpath is not None and relpath != '.':
2067
if not base.endswith('/'):
2069
# XXX: Really base should be a url; we did after all call
2070
# get_url()! But sometimes it's just a path (from
2071
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2072
# to a non-escaped local path.
2073
if base.startswith('./') or base.startswith('/'):
2076
base += urlutils.escape(relpath)
2079
def get_url(self, relpath=None):
2080
"""Get a URL (or maybe a path) for the readwrite transport.
2082
This will either be backed by '.' or to an equivalent non-file based
2084
relpath provides for clients to get a path relative to the base url.
2085
These should only be downwards relative, not upwards.
2087
base = self.get_server().get_url()
2088
return self._adjust_url(base, relpath)
2090
def get_vfs_only_url(self, relpath=None):
2091
"""Get a URL (or maybe a path for the plain old vfs transport.
2093
This will never be a smart protocol. It always has all the
2094
capabilities of the local filesystem, but it might actually be a
2095
MemoryTransport or some other similar virtual filesystem.
2097
This is the backing transport (if any) of the server returned by
2098
get_url and get_readonly_url.
2100
:param relpath: provides for clients to get a path relative to the base
2101
url. These should only be downwards relative, not upwards.
2104
base = self.get_vfs_only_server().get_url()
2105
return self._adjust_url(base, relpath)
2107
def _create_safety_net(self):
2108
"""Make a fake bzr directory.
2110
This prevents any tests propagating up onto the TEST_ROOT directory's
2113
root = TestCaseWithMemoryTransport.TEST_ROOT
2114
bzrdir.BzrDir.create_standalone_workingtree(root)
2116
def _check_safety_net(self):
2117
"""Check that the safety .bzr directory have not been touched.
2119
_make_test_root have created a .bzr directory to prevent tests from
2120
propagating. This method ensures than a test did not leaked.
2122
root = TestCaseWithMemoryTransport.TEST_ROOT
2123
wt = workingtree.WorkingTree.open(root)
2124
last_rev = wt.last_revision()
2125
if last_rev != 'null:':
2126
# The current test have modified the /bzr directory, we need to
2127
# recreate a new one or all the followng tests will fail.
2128
# If you need to inspect its content uncomment the following line
2129
# import pdb; pdb.set_trace()
2130
_rmtree_temp_dir(root + '/.bzr')
2131
self._create_safety_net()
2132
raise AssertionError('%s/.bzr should not be modified' % root)
2134
def _make_test_root(self):
2135
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2136
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2137
TestCaseWithMemoryTransport.TEST_ROOT = root
2139
self._create_safety_net()
2141
# The same directory is used by all tests, and we're not
2142
# specifically told when all tests are finished. This will do.
2143
atexit.register(_rmtree_temp_dir, root)
2145
self.addCleanup(self._check_safety_net)
2147
def makeAndChdirToTestDir(self):
2148
"""Create a temporary directories for this one test.
2150
This must set self.test_home_dir and self.test_dir and chdir to
2153
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2155
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2156
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2157
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2159
def make_branch(self, relpath, format=None):
2160
"""Create a branch on the transport at relpath."""
2161
repo = self.make_repository(relpath, format=format)
2162
return repo.bzrdir.create_branch()
2164
def make_bzrdir(self, relpath, format=None):
2166
# might be a relative or absolute path
2167
maybe_a_url = self.get_url(relpath)
2168
segments = maybe_a_url.rsplit('/', 1)
2169
t = get_transport(maybe_a_url)
2170
if len(segments) > 1 and segments[-1] not in ('', '.'):
2174
if isinstance(format, basestring):
2175
format = bzrdir.format_registry.make_bzrdir(format)
2176
return format.initialize_on_transport(t)
2177
except errors.UninitializableFormat:
2178
raise TestSkipped("Format %s is not initializable." % format)
2180
def make_repository(self, relpath, shared=False, format=None):
2181
"""Create a repository on our default transport at relpath.
2183
Note that relpath must be a relative path, not a full url.
2185
# FIXME: If you create a remoterepository this returns the underlying
2186
# real format, which is incorrect. Actually we should make sure that
2187
# RemoteBzrDir returns a RemoteRepository.
2188
# maybe mbp 20070410
2189
made_control = self.make_bzrdir(relpath, format=format)
2190
return made_control.create_repository(shared=shared)
2192
def make_smart_server(self, path):
2193
smart_server = server.SmartTCPServer_for_testing()
2194
smart_server.setUp(self.get_server())
2195
remote_transport = get_transport(smart_server.get_url()).clone(path)
2196
self.addCleanup(smart_server.tearDown)
2197
return remote_transport
2199
def make_branch_and_memory_tree(self, relpath, format=None):
2200
"""Create a branch on the default transport and a MemoryTree for it."""
2201
b = self.make_branch(relpath, format=format)
2202
return memorytree.MemoryTree.create_on_branch(b)
2204
def make_branch_builder(self, relpath, format=None):
2205
branch = self.make_branch(relpath, format=format)
2206
return branchbuilder.BranchBuilder(branch=branch)
2208
def overrideEnvironmentForTesting(self):
2209
os.environ['HOME'] = self.test_home_dir
2210
os.environ['BZR_HOME'] = self.test_home_dir
2213
super(TestCaseWithMemoryTransport, self).setUp()
2214
self._make_test_root()
2215
_currentdir = os.getcwdu()
2216
def _leaveDirectory():
2217
os.chdir(_currentdir)
2218
self.addCleanup(_leaveDirectory)
2219
self.makeAndChdirToTestDir()
2220
self.overrideEnvironmentForTesting()
2221
self.__readonly_server = None
2222
self.__server = None
2223
self.reduceLockdirTimeout()
2225
def setup_smart_server_with_call_log(self):
2226
"""Sets up a smart server as the transport server with a call log."""
2227
self.transport_server = server.SmartTCPServer_for_testing
2228
self.hpss_calls = []
2230
# Skip the current stack down to the caller of
2231
# setup_smart_server_with_call_log
2232
prefix_length = len(traceback.extract_stack()) - 2
2233
def capture_hpss_call(params):
2234
self.hpss_calls.append(
2235
CapturedCall(params, prefix_length))
2236
client._SmartClient.hooks.install_named_hook(
2237
'call', capture_hpss_call, None)
2239
def reset_smart_call_log(self):
2240
self.hpss_calls = []
2243
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2244
"""Derived class that runs a test within a temporary directory.
2246
This is useful for tests that need to create a branch, etc.
2248
The directory is created in a slightly complex way: for each
2249
Python invocation, a new temporary top-level directory is created.
2250
All test cases create their own directory within that. If the
2251
tests complete successfully, the directory is removed.
2253
:ivar test_base_dir: The path of the top-level directory for this
2254
test, which contains a home directory and a work directory.
2256
:ivar test_home_dir: An initially empty directory under test_base_dir
2257
which is used as $HOME for this test.
2259
:ivar test_dir: A directory under test_base_dir used as the current
2260
directory when the test proper is run.
2263
OVERRIDE_PYTHON = 'python'
2265
def check_file_contents(self, filename, expect):
2266
self.log("check contents of file %s" % filename)
2267
contents = file(filename, 'r').read()
2268
if contents != expect:
2269
self.log("expected: %r" % expect)
2270
self.log("actually: %r" % contents)
2271
self.fail("contents of %s not as expected" % filename)
2273
def _getTestDirPrefix(self):
2274
# create a directory within the top level test directory
2275
if sys.platform == 'win32':
2276
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2277
# windows is likely to have path-length limits so use a short name
2278
name_prefix = name_prefix[-30:]
2280
name_prefix = re.sub('[/]', '_', self.id())
2283
def makeAndChdirToTestDir(self):
2284
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2286
For TestCaseInTempDir we create a temporary directory based on the test
2287
name and then create two subdirs - test and home under it.
2289
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2290
self._getTestDirPrefix())
2292
for i in range(100):
2293
if os.path.exists(name):
2294
name = name_prefix + '_' + str(i)
2298
# now create test and home directories within this dir
2299
self.test_base_dir = name
2300
self.test_home_dir = self.test_base_dir + '/home'
2301
os.mkdir(self.test_home_dir)
2302
self.test_dir = self.test_base_dir + '/work'
2303
os.mkdir(self.test_dir)
2304
os.chdir(self.test_dir)
2305
# put name of test inside
2306
f = file(self.test_base_dir + '/name', 'w')
2311
self.addCleanup(self.deleteTestDir)
2313
def deleteTestDir(self):
2314
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2315
_rmtree_temp_dir(self.test_base_dir)
2317
def build_tree(self, shape, line_endings='binary', transport=None):
2318
"""Build a test tree according to a pattern.
2320
shape is a sequence of file specifications. If the final
2321
character is '/', a directory is created.
2323
This assumes that all the elements in the tree being built are new.
2325
This doesn't add anything to a branch.
2327
:type shape: list or tuple.
2328
:param line_endings: Either 'binary' or 'native'
2329
in binary mode, exact contents are written in native mode, the
2330
line endings match the default platform endings.
2331
:param transport: A transport to write to, for building trees on VFS's.
2332
If the transport is readonly or None, "." is opened automatically.
2335
if type(shape) not in (list, tuple):
2336
raise AssertionError("Parameter 'shape' should be "
2337
"a list or a tuple. Got %r instead" % (shape,))
2338
# It's OK to just create them using forward slashes on windows.
2339
if transport is None or transport.is_readonly():
2340
transport = get_transport(".")
2342
self.assertIsInstance(name, basestring)
2344
transport.mkdir(urlutils.escape(name[:-1]))
2346
if line_endings == 'binary':
2348
elif line_endings == 'native':
2351
raise errors.BzrError(
2352
'Invalid line ending request %r' % line_endings)
2353
content = "contents of %s%s" % (name.encode('utf-8'), end)
2354
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2356
def build_tree_contents(self, shape):
2357
build_tree_contents(shape)
2359
def assertInWorkingTree(self, path, root_path='.', tree=None):
2360
"""Assert whether path or paths are in the WorkingTree"""
2362
tree = workingtree.WorkingTree.open(root_path)
2363
if not isinstance(path, basestring):
2365
self.assertInWorkingTree(p, tree=tree)
2367
self.assertIsNot(tree.path2id(path), None,
2368
path+' not in working tree.')
2370
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2371
"""Assert whether path or paths are not in the WorkingTree"""
2373
tree = workingtree.WorkingTree.open(root_path)
2374
if not isinstance(path, basestring):
2376
self.assertNotInWorkingTree(p,tree=tree)
2378
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2381
class TestCaseWithTransport(TestCaseInTempDir):
2382
"""A test case that provides get_url and get_readonly_url facilities.
2384
These back onto two transport servers, one for readonly access and one for
2387
If no explicit class is provided for readonly access, a
2388
ReadonlyTransportDecorator is used instead which allows the use of non disk
2389
based read write transports.
2391
If an explicit class is provided for readonly access, that server and the
2392
readwrite one must both define get_url() as resolving to os.getcwd().
2395
def get_vfs_only_server(self):
2396
"""See TestCaseWithMemoryTransport.
2398
This is useful for some tests with specific servers that need
2401
if self.__vfs_server is None:
2402
self.__vfs_server = self.vfs_transport_factory()
2403
self.__vfs_server.setUp()
2404
self.addCleanup(self.__vfs_server.tearDown)
2405
return self.__vfs_server
2407
def make_branch_and_tree(self, relpath, format=None):
2408
"""Create a branch on the transport and a tree locally.
2410
If the transport is not a LocalTransport, the Tree can't be created on
2411
the transport. In that case if the vfs_transport_factory is
2412
LocalURLServer the working tree is created in the local
2413
directory backing the transport, and the returned tree's branch and
2414
repository will also be accessed locally. Otherwise a lightweight
2415
checkout is created and returned.
2417
:param format: The BzrDirFormat.
2418
:returns: the WorkingTree.
2420
# TODO: always use the local disk path for the working tree,
2421
# this obviously requires a format that supports branch references
2422
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2424
b = self.make_branch(relpath, format=format)
2426
return b.bzrdir.create_workingtree()
2427
except errors.NotLocalUrl:
2428
# We can only make working trees locally at the moment. If the
2429
# transport can't support them, then we keep the non-disk-backed
2430
# branch and create a local checkout.
2431
if self.vfs_transport_factory is LocalURLServer:
2432
# the branch is colocated on disk, we cannot create a checkout.
2433
# hopefully callers will expect this.
2434
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2435
wt = local_controldir.create_workingtree()
2436
if wt.branch._format != b._format:
2438
# Make sure that assigning to wt._branch fixes wt.branch,
2439
# in case the implementation details of workingtree objects
2441
self.assertIs(b, wt.branch)
2444
return b.create_checkout(relpath, lightweight=True)
2446
def assertIsDirectory(self, relpath, transport):
2447
"""Assert that relpath within transport is a directory.
2449
This may not be possible on all transports; in that case it propagates
2450
a TransportNotPossible.
2453
mode = transport.stat(relpath).st_mode
2454
except errors.NoSuchFile:
2455
self.fail("path %s is not a directory; no such file"
2457
if not stat.S_ISDIR(mode):
2458
self.fail("path %s is not a directory; has mode %#o"
2461
def assertTreesEqual(self, left, right):
2462
"""Check that left and right have the same content and properties."""
2463
# we use a tree delta to check for equality of the content, and we
2464
# manually check for equality of other things such as the parents list.
2465
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2466
differences = left.changes_from(right)
2467
self.assertFalse(differences.has_changed(),
2468
"Trees %r and %r are different: %r" % (left, right, differences))
2471
super(TestCaseWithTransport, self).setUp()
2472
self.__vfs_server = None
2475
class ChrootedTestCase(TestCaseWithTransport):
2476
"""A support class that provides readonly urls outside the local namespace.
2478
This is done by checking if self.transport_server is a MemoryServer. if it
2479
is then we are chrooted already, if it is not then an HttpServer is used
2482
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2483
be used without needed to redo it when a different
2484
subclass is in use ?
2488
super(ChrootedTestCase, self).setUp()
2489
if not self.vfs_transport_factory == MemoryServer:
2490
self.transport_readonly_server = HttpServer
2493
def condition_id_re(pattern):
2494
"""Create a condition filter which performs a re check on a test's id.
2496
:param pattern: A regular expression string.
2497
:return: A callable that returns True if the re matches.
2499
filter_re = osutils.re_compile_checked(pattern, 0,
2501
def condition(test):
2503
return filter_re.search(test_id)
2507
def condition_isinstance(klass_or_klass_list):
2508
"""Create a condition filter which returns isinstance(param, klass).
2510
:return: A callable which when called with one parameter obj return the
2511
result of isinstance(obj, klass_or_klass_list).
2514
return isinstance(obj, klass_or_klass_list)
2518
def condition_id_in_list(id_list):
2519
"""Create a condition filter which verify that test's id in a list.
2521
:param id_list: A TestIdList object.
2522
:return: A callable that returns True if the test's id appears in the list.
2524
def condition(test):
2525
return id_list.includes(test.id())
2529
def condition_id_startswith(starts):
2530
"""Create a condition filter verifying that test's id starts with a string.
2532
:param starts: A list of string.
2533
:return: A callable that returns True if the test's id starts with one of
2536
def condition(test):
2537
for start in starts:
2538
if test.id().startswith(start):
2544
def exclude_tests_by_condition(suite, condition):
2545
"""Create a test suite which excludes some tests from suite.
2547
:param suite: The suite to get tests from.
2548
:param condition: A callable whose result evaluates True when called with a
2549
test case which should be excluded from the result.
2550
:return: A suite which contains the tests found in suite that fail
2554
for test in iter_suite_tests(suite):
2555
if not condition(test):
2557
return TestUtil.TestSuite(result)
2560
def filter_suite_by_condition(suite, condition):
2561
"""Create a test suite by filtering another one.
2563
:param suite: The source suite.
2564
:param condition: A callable whose result evaluates True when called with a
2565
test case which should be included in the result.
2566
:return: A suite which contains the tests found in suite that pass
2570
for test in iter_suite_tests(suite):
2573
return TestUtil.TestSuite(result)
2576
def filter_suite_by_re(suite, pattern):
2577
"""Create a test suite by filtering another one.
2579
:param suite: the source suite
2580
:param pattern: pattern that names must match
2581
:returns: the newly created suite
2583
condition = condition_id_re(pattern)
2584
result_suite = filter_suite_by_condition(suite, condition)
2588
def filter_suite_by_id_list(suite, test_id_list):
2589
"""Create a test suite by filtering another one.
2591
:param suite: The source suite.
2592
:param test_id_list: A list of the test ids to keep as strings.
2593
:returns: the newly created suite
2595
condition = condition_id_in_list(test_id_list)
2596
result_suite = filter_suite_by_condition(suite, condition)
2600
def filter_suite_by_id_startswith(suite, start):
2601
"""Create a test suite by filtering another one.
2603
:param suite: The source suite.
2604
:param start: A list of string the test id must start with one of.
2605
:returns: the newly created suite
2607
condition = condition_id_startswith(start)
2608
result_suite = filter_suite_by_condition(suite, condition)
2612
def exclude_tests_by_re(suite, pattern):
2613
"""Create a test suite which excludes some tests from suite.
2615
:param suite: The suite to get tests from.
2616
:param pattern: A regular expression string. Test ids that match this
2617
pattern will be excluded from the result.
2618
:return: A TestSuite that contains all the tests from suite without the
2619
tests that matched pattern. The order of tests is the same as it was in
2622
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2625
def preserve_input(something):
2626
"""A helper for performing test suite transformation chains.
2628
:param something: Anything you want to preserve.
2634
def randomize_suite(suite):
2635
"""Return a new TestSuite with suite's tests in random order.
2637
The tests in the input suite are flattened into a single suite in order to
2638
accomplish this. Any nested TestSuites are removed to provide global
2641
tests = list(iter_suite_tests(suite))
2642
random.shuffle(tests)
2643
return TestUtil.TestSuite(tests)
2646
def split_suite_by_condition(suite, condition):
2647
"""Split a test suite into two by a condition.
2649
:param suite: The suite to split.
2650
:param condition: The condition to match on. Tests that match this
2651
condition are returned in the first test suite, ones that do not match
2652
are in the second suite.
2653
:return: A tuple of two test suites, where the first contains tests from
2654
suite matching the condition, and the second contains the remainder
2655
from suite. The order within each output suite is the same as it was in
2660
for test in iter_suite_tests(suite):
2662
matched.append(test)
2664
did_not_match.append(test)
2665
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2668
def split_suite_by_re(suite, pattern):
2669
"""Split a test suite into two by a regular expression.
2671
:param suite: The suite to split.
2672
:param pattern: A regular expression string. Test ids that match this
2673
pattern will be in the first test suite returned, and the others in the
2674
second test suite returned.
2675
:return: A tuple of two test suites, where the first contains tests from
2676
suite matching pattern, and the second contains the remainder from
2677
suite. The order within each output suite is the same as it was in
2680
return split_suite_by_condition(suite, condition_id_re(pattern))
2683
def run_suite(suite, name='test', verbose=False, pattern=".*",
2684
stop_on_failure=False,
2685
transport=None, lsprof_timed=None, bench_history=None,
2686
matching_tests_first=None,
2689
exclude_pattern=None,
2692
suite_decorators=None,
2694
"""Run a test suite for bzr selftest.
2696
:param runner_class: The class of runner to use. Must support the
2697
constructor arguments passed by run_suite which are more than standard
2699
:return: A boolean indicating success.
2701
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2706
if runner_class is None:
2707
runner_class = TextTestRunner
2710
runner = runner_class(stream=stream,
2712
verbosity=verbosity,
2713
bench_history=bench_history,
2714
list_only=list_only,
2717
runner.stop_on_failure=stop_on_failure
2718
# built in decorator factories:
2720
random_order(random_seed, runner),
2721
exclude_tests(exclude_pattern),
2723
if matching_tests_first:
2724
decorators.append(tests_first(pattern))
2726
decorators.append(filter_tests(pattern))
2727
if suite_decorators:
2728
decorators.extend(suite_decorators)
2729
for decorator in decorators:
2730
suite = decorator(suite)
2731
result = runner.run(suite)
2736
return result.wasStrictlySuccessful()
2738
return result.wasSuccessful()
2741
# A registry where get() returns a suite decorator.
2742
parallel_registry = registry.Registry()
2745
def fork_decorator(suite):
2746
concurrency = local_concurrency()
2747
if concurrency == 1:
2749
from testtools import ConcurrentTestSuite
2750
return ConcurrentTestSuite(suite, fork_for_tests)
2751
parallel_registry.register('fork', fork_decorator)
2754
def subprocess_decorator(suite):
2755
concurrency = local_concurrency()
2756
if concurrency == 1:
2758
from testtools import ConcurrentTestSuite
2759
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2760
parallel_registry.register('subprocess', subprocess_decorator)
2763
def exclude_tests(exclude_pattern):
2764
"""Return a test suite decorator that excludes tests."""
2765
if exclude_pattern is None:
2766
return identity_decorator
2767
def decorator(suite):
2768
return ExcludeDecorator(suite, exclude_pattern)
2772
def filter_tests(pattern):
2774
return identity_decorator
2775
def decorator(suite):
2776
return FilterTestsDecorator(suite, pattern)
2780
def random_order(random_seed, runner):
2781
"""Return a test suite decorator factory for randomising tests order.
2783
:param random_seed: now, a string which casts to a long, or a long.
2784
:param runner: A test runner with a stream attribute to report on.
2786
if random_seed is None:
2787
return identity_decorator
2788
def decorator(suite):
2789
return RandomDecorator(suite, random_seed, runner.stream)
2793
def tests_first(pattern):
2795
return identity_decorator
2796
def decorator(suite):
2797
return TestFirstDecorator(suite, pattern)
2801
def identity_decorator(suite):
2806
class TestDecorator(TestSuite):
2807
"""A decorator for TestCase/TestSuite objects.
2809
Usually, subclasses should override __iter__(used when flattening test
2810
suites), which we do to filter, reorder, parallelise and so on, run() and
2814
def __init__(self, suite):
2815
TestSuite.__init__(self)
2818
def countTestCases(self):
2821
cases += test.countTestCases()
2828
def run(self, result):
2829
# Use iteration on self, not self._tests, to allow subclasses to hook
2832
if result.shouldStop:
2838
class ExcludeDecorator(TestDecorator):
2839
"""A decorator which excludes test matching an exclude pattern."""
2841
def __init__(self, suite, exclude_pattern):
2842
TestDecorator.__init__(self, suite)
2843
self.exclude_pattern = exclude_pattern
2844
self.excluded = False
2848
return iter(self._tests)
2849
self.excluded = True
2850
suite = exclude_tests_by_re(self, self.exclude_pattern)
2852
self.addTests(suite)
2853
return iter(self._tests)
2856
class FilterTestsDecorator(TestDecorator):
2857
"""A decorator which filters tests to those matching a pattern."""
2859
def __init__(self, suite, pattern):
2860
TestDecorator.__init__(self, suite)
2861
self.pattern = pattern
2862
self.filtered = False
2866
return iter(self._tests)
2867
self.filtered = True
2868
suite = filter_suite_by_re(self, self.pattern)
2870
self.addTests(suite)
2871
return iter(self._tests)
2874
class RandomDecorator(TestDecorator):
2875
"""A decorator which randomises the order of its tests."""
2877
def __init__(self, suite, random_seed, stream):
2878
TestDecorator.__init__(self, suite)
2879
self.random_seed = random_seed
2880
self.randomised = False
2881
self.stream = stream
2885
return iter(self._tests)
2886
self.randomised = True
2887
self.stream.writeln("Randomizing test order using seed %s\n" %
2888
(self.actual_seed()))
2889
# Initialise the random number generator.
2890
random.seed(self.actual_seed())
2891
suite = randomize_suite(self)
2893
self.addTests(suite)
2894
return iter(self._tests)
2896
def actual_seed(self):
2897
if self.random_seed == "now":
2898
# We convert the seed to a long to make it reuseable across
2899
# invocations (because the user can reenter it).
2900
self.random_seed = long(time.time())
2902
# Convert the seed to a long if we can
2904
self.random_seed = long(self.random_seed)
2907
return self.random_seed
2910
class TestFirstDecorator(TestDecorator):
2911
"""A decorator which moves named tests to the front."""
2913
def __init__(self, suite, pattern):
2914
TestDecorator.__init__(self, suite)
2915
self.pattern = pattern
2916
self.filtered = False
2920
return iter(self._tests)
2921
self.filtered = True
2922
suites = split_suite_by_re(self, self.pattern)
2924
self.addTests(suites)
2925
return iter(self._tests)
2928
def partition_tests(suite, count):
2929
"""Partition suite into count lists of tests."""
2931
tests = list(iter_suite_tests(suite))
2932
tests_per_process = int(math.ceil(float(len(tests)) / count))
2933
for block in range(count):
2934
low_test = block * tests_per_process
2935
high_test = low_test + tests_per_process
2936
process_tests = tests[low_test:high_test]
2937
result.append(process_tests)
2941
def fork_for_tests(suite):
2942
"""Take suite and start up one runner per CPU by forking()
2944
:return: An iterable of TestCase-like objects which can each have
2945
run(result) called on them to feed tests to result.
2947
concurrency = local_concurrency()
2949
from subunit import TestProtocolClient, ProtocolTestCase
2950
class TestInOtherProcess(ProtocolTestCase):
2951
# Should be in subunit, I think. RBC.
2952
def __init__(self, stream, pid):
2953
ProtocolTestCase.__init__(self, stream)
2956
def run(self, result):
2958
ProtocolTestCase.run(self, result)
2960
os.waitpid(self.pid, os.WNOHANG)
2962
test_blocks = partition_tests(suite, concurrency)
2963
for process_tests in test_blocks:
2964
process_suite = TestSuite()
2965
process_suite.addTests(process_tests)
2966
c2pread, c2pwrite = os.pipe()
2971
# Leave stderr and stdout open so we can see test noise
2972
# Close stdin so that the child goes away if it decides to
2973
# read from stdin (otherwise its a roulette to see what
2974
# child actually gets keystrokes for pdb etc).
2977
stream = os.fdopen(c2pwrite, 'wb', 1)
2978
subunit_result = TestProtocolClient(stream)
2979
process_suite.run(subunit_result)
2984
stream = os.fdopen(c2pread, 'rb', 1)
2985
test = TestInOtherProcess(stream, pid)
2990
def reinvoke_for_tests(suite):
2991
"""Take suite and start up one runner per CPU using subprocess().
2993
:return: An iterable of TestCase-like objects which can each have
2994
run(result) called on them to feed tests to result.
2996
concurrency = local_concurrency()
2998
from subunit import TestProtocolClient, ProtocolTestCase
2999
class TestInSubprocess(ProtocolTestCase):
3000
def __init__(self, process, name):
3001
ProtocolTestCase.__init__(self, process.stdout)
3002
self.process = process
3003
self.process.stdin.close()
3006
def run(self, result):
3008
ProtocolTestCase.run(self, result)
3011
os.unlink(self.name)
3012
# print "pid %d finished" % finished_process
3013
test_blocks = partition_tests(suite, concurrency)
3014
for process_tests in test_blocks:
3015
# ugly; currently reimplement rather than reuses TestCase methods.
3016
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3017
if not os.path.isfile(bzr_path):
3018
# We are probably installed. Assume sys.argv is the right file
3019
bzr_path = sys.argv[0]
3020
fd, test_list_file_name = tempfile.mkstemp()
3021
test_list_file = os.fdopen(fd, 'wb', 1)
3022
for test in process_tests:
3023
test_list_file.write(test.id() + '\n')
3024
test_list_file.close()
3026
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3028
if '--no-plugins' in sys.argv:
3029
argv.append('--no-plugins')
3030
# stderr=STDOUT would be ideal, but until we prevent noise on
3031
# stderr it can interrupt the subunit protocol.
3032
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3034
test = TestInSubprocess(process, test_list_file_name)
3037
os.unlink(test_list_file_name)
3042
def cpucount(content):
3043
lines = content.splitlines()
3044
prefix = 'processor'
3046
if line.startswith(prefix):
3047
concurrency = int(line[line.find(':')+1:]) + 1
3051
def local_concurrency():
3053
content = file('/proc/cpuinfo', 'rb').read()
3054
concurrency = cpucount(content)
3055
except Exception, e:
3060
class BZRTransformingResult(unittest.TestResult):
3062
def __init__(self, target):
3063
unittest.TestResult.__init__(self)
3064
self.result = target
3066
def startTest(self, test):
3067
self.result.startTest(test)
3069
def stopTest(self, test):
3070
self.result.stopTest(test)
3072
def addError(self, test, err):
3073
feature = self._error_looks_like('UnavailableFeature: ', err)
3074
if feature is not None:
3075
self.result.addNotSupported(test, feature)
3077
self.result.addError(test, err)
3079
def addFailure(self, test, err):
3080
known = self._error_looks_like('KnownFailure: ', err)
3081
if known is not None:
3082
self.result._addKnownFailure(test, [KnownFailure,
3083
KnownFailure(known), None])
3085
self.result.addFailure(test, err)
3087
def addSkip(self, test, reason):
3088
self.result.addSkip(test, reason)
3090
def addSuccess(self, test):
3091
self.result.addSuccess(test)
3093
def _error_looks_like(self, prefix, err):
3094
"""Deserialize exception and returns the stringify value."""
3098
if isinstance(exc, subunit.RemoteException):
3099
# stringify the exception gives access to the remote traceback
3100
# We search the last line for 'prefix'
3101
lines = str(exc).split('\n')
3102
while lines and not lines[-1]:
3105
if lines[-1].startswith(prefix):
3106
value = lines[-1][len(prefix):]
3110
# Controlled by "bzr selftest -E=..." option
3111
selftest_debug_flags = set()
3114
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3116
test_suite_factory=None,
3119
matching_tests_first=None,
3122
exclude_pattern=None,
3128
suite_decorators=None,
3130
"""Run the whole test suite under the enhanced runner"""
3131
# XXX: Very ugly way to do this...
3132
# Disable warning about old formats because we don't want it to disturb
3133
# any blackbox tests.
3134
from bzrlib import repository
3135
repository._deprecation_warning_done = True
3137
global default_transport
3138
if transport is None:
3139
transport = default_transport
3140
old_transport = default_transport
3141
default_transport = transport
3142
global selftest_debug_flags
3143
old_debug_flags = selftest_debug_flags
3144
if debug_flags is not None:
3145
selftest_debug_flags = set(debug_flags)
3147
if load_list is None:
3150
keep_only = load_test_id_list(load_list)
3151
if test_suite_factory is None:
3152
suite = test_suite(keep_only, starting_with)
3154
suite = test_suite_factory()
3155
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3156
stop_on_failure=stop_on_failure,
3157
transport=transport,
3158
lsprof_timed=lsprof_timed,
3159
bench_history=bench_history,
3160
matching_tests_first=matching_tests_first,
3161
list_only=list_only,
3162
random_seed=random_seed,
3163
exclude_pattern=exclude_pattern,
3165
runner_class=runner_class,
3166
suite_decorators=suite_decorators,
3169
default_transport = old_transport
3170
selftest_debug_flags = old_debug_flags
3173
def load_test_id_list(file_name):
3174
"""Load a test id list from a text file.
3176
The format is one test id by line. No special care is taken to impose
3177
strict rules, these test ids are used to filter the test suite so a test id
3178
that do not match an existing test will do no harm. This allows user to add
3179
comments, leave blank lines, etc.
3183
ftest = open(file_name, 'rt')
3185
if e.errno != errno.ENOENT:
3188
raise errors.NoSuchFile(file_name)
3190
for test_name in ftest.readlines():
3191
test_list.append(test_name.strip())
3196
def suite_matches_id_list(test_suite, id_list):
3197
"""Warns about tests not appearing or appearing more than once.
3199
:param test_suite: A TestSuite object.
3200
:param test_id_list: The list of test ids that should be found in
3203
:return: (absents, duplicates) absents is a list containing the test found
3204
in id_list but not in test_suite, duplicates is a list containing the
3205
test found multiple times in test_suite.
3207
When using a prefined test id list, it may occurs that some tests do not
3208
exist anymore or that some tests use the same id. This function warns the
3209
tester about potential problems in his workflow (test lists are volatile)
3210
or in the test suite itself (using the same id for several tests does not
3211
help to localize defects).
3213
# Build a dict counting id occurrences
3215
for test in iter_suite_tests(test_suite):
3217
tests[id] = tests.get(id, 0) + 1
3222
occurs = tests.get(id, 0)
3224
not_found.append(id)
3226
duplicates.append(id)
3228
return not_found, duplicates
3231
class TestIdList(object):
3232
"""Test id list to filter a test suite.
3234
Relying on the assumption that test ids are built as:
3235
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3236
notation, this class offers methods to :
3237
- avoid building a test suite for modules not refered to in the test list,
3238
- keep only the tests listed from the module test suite.
3241
def __init__(self, test_id_list):
3242
# When a test suite needs to be filtered against us we compare test ids
3243
# for equality, so a simple dict offers a quick and simple solution.
3244
self.tests = dict().fromkeys(test_id_list, True)
3246
# While unittest.TestCase have ids like:
3247
# <module>.<class>.<method>[(<param+)],
3248
# doctest.DocTestCase can have ids like:
3251
# <module>.<function>
3252
# <module>.<class>.<method>
3254
# Since we can't predict a test class from its name only, we settle on
3255
# a simple constraint: a test id always begins with its module name.
3258
for test_id in test_id_list:
3259
parts = test_id.split('.')
3260
mod_name = parts.pop(0)
3261
modules[mod_name] = True
3263
mod_name += '.' + part
3264
modules[mod_name] = True
3265
self.modules = modules
3267
def refers_to(self, module_name):
3268
"""Is there tests for the module or one of its sub modules."""
3269
return self.modules.has_key(module_name)
3271
def includes(self, test_id):
3272
return self.tests.has_key(test_id)
3275
class TestPrefixAliasRegistry(registry.Registry):
3276
"""A registry for test prefix aliases.
3278
This helps implement shorcuts for the --starting-with selftest
3279
option. Overriding existing prefixes is not allowed but not fatal (a
3280
warning will be emitted).
3283
def register(self, key, obj, help=None, info=None,
3284
override_existing=False):
3285
"""See Registry.register.
3287
Trying to override an existing alias causes a warning to be emitted,
3288
not a fatal execption.
3291
super(TestPrefixAliasRegistry, self).register(
3292
key, obj, help=help, info=info, override_existing=False)
3294
actual = self.get(key)
3295
note('Test prefix alias %s is already used for %s, ignoring %s'
3296
% (key, actual, obj))
3298
def resolve_alias(self, id_start):
3299
"""Replace the alias by the prefix in the given string.
3301
Using an unknown prefix is an error to help catching typos.
3303
parts = id_start.split('.')
3305
parts[0] = self.get(parts[0])
3307
raise errors.BzrCommandError(
3308
'%s is not a known test prefix alias' % parts[0])
3309
return '.'.join(parts)
3312
test_prefix_alias_registry = TestPrefixAliasRegistry()
3313
"""Registry of test prefix aliases."""
3316
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3317
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3318
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3320
# Obvious higest levels prefixes, feel free to add your own via a plugin
3321
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3322
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3323
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3324
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3325
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3328
def test_suite(keep_only=None, starting_with=None):
3329
"""Build and return TestSuite for the whole of bzrlib.
3331
:param keep_only: A list of test ids limiting the suite returned.
3333
:param starting_with: An id limiting the suite returned to the tests
3336
This function can be replaced if you need to change the default test
3337
suite on a global basis, but it is not encouraged.
3341
'bzrlib.tests.blackbox',
3342
'bzrlib.tests.branch_implementations',
3343
'bzrlib.tests.bzrdir_implementations',
3344
'bzrlib.tests.commands',
3345
'bzrlib.tests.interrepository_implementations',
3346
'bzrlib.tests.intertree_implementations',
3347
'bzrlib.tests.inventory_implementations',
3348
'bzrlib.tests.per_interbranch',
3349
'bzrlib.tests.per_lock',
3350
'bzrlib.tests.per_repository',
3351
'bzrlib.tests.per_repository_chk',
3352
'bzrlib.tests.per_repository_reference',
3353
'bzrlib.tests.test__chk_map',
3354
'bzrlib.tests.test__dirstate_helpers',
3355
'bzrlib.tests.test__groupcompress',
3356
'bzrlib.tests.test__walkdirs_win32',
3357
'bzrlib.tests.test_ancestry',
3358
'bzrlib.tests.test_annotate',
3359
'bzrlib.tests.test_api',
3360
'bzrlib.tests.test_atomicfile',
3361
'bzrlib.tests.test_bad_files',
3362
'bzrlib.tests.test_bisect_multi',
3363
'bzrlib.tests.test_branch',
3364
'bzrlib.tests.test_branchbuilder',
3365
'bzrlib.tests.test_btree_index',
3366
'bzrlib.tests.test_bugtracker',
3367
'bzrlib.tests.test_bundle',
3368
'bzrlib.tests.test_bzrdir',
3369
'bzrlib.tests.test__chunks_to_lines',
3370
'bzrlib.tests.test_cache_utf8',
3371
'bzrlib.tests.test_chk_map',
3372
'bzrlib.tests.test_chunk_writer',
3373
'bzrlib.tests.test_clean_tree',
3374
'bzrlib.tests.test_commands',
3375
'bzrlib.tests.test_commit',
3376
'bzrlib.tests.test_commit_merge',
3377
'bzrlib.tests.test_config',
3378
'bzrlib.tests.test_conflicts',
3379
'bzrlib.tests.test_counted_lock',
3380
'bzrlib.tests.test_decorators',
3381
'bzrlib.tests.test_delta',
3382
'bzrlib.tests.test_debug',
3383
'bzrlib.tests.test_deprecated_graph',
3384
'bzrlib.tests.test_diff',
3385
'bzrlib.tests.test_directory_service',
3386
'bzrlib.tests.test_dirstate',
3387
'bzrlib.tests.test_email_message',
3388
'bzrlib.tests.test_eol_filters',
3389
'bzrlib.tests.test_errors',
3390
'bzrlib.tests.test_export',
3391
'bzrlib.tests.test_extract',
3392
'bzrlib.tests.test_fetch',
3393
'bzrlib.tests.test_fifo_cache',
3394
'bzrlib.tests.test_filters',
3395
'bzrlib.tests.test_ftp_transport',
3396
'bzrlib.tests.test_foreign',
3397
'bzrlib.tests.test_generate_docs',
3398
'bzrlib.tests.test_generate_ids',
3399
'bzrlib.tests.test_globbing',
3400
'bzrlib.tests.test_gpg',
3401
'bzrlib.tests.test_graph',
3402
'bzrlib.tests.test_groupcompress',
3403
'bzrlib.tests.test_hashcache',
3404
'bzrlib.tests.test_help',
3405
'bzrlib.tests.test_hooks',
3406
'bzrlib.tests.test_http',
3407
'bzrlib.tests.test_http_implementations',
3408
'bzrlib.tests.test_http_response',
3409
'bzrlib.tests.test_https_ca_bundle',
3410
'bzrlib.tests.test_identitymap',
3411
'bzrlib.tests.test_ignores',
3412
'bzrlib.tests.test_index',
3413
'bzrlib.tests.test_info',
3414
'bzrlib.tests.test_inv',
3415
'bzrlib.tests.test_inventory_delta',
3416
'bzrlib.tests.test_knit',
3417
'bzrlib.tests.test_lazy_import',
3418
'bzrlib.tests.test_lazy_regex',
3419
'bzrlib.tests.test_lockable_files',
3420
'bzrlib.tests.test_lockdir',
3421
'bzrlib.tests.test_log',
3422
'bzrlib.tests.test_lru_cache',
3423
'bzrlib.tests.test_lsprof',
3424
'bzrlib.tests.test_mail_client',
3425
'bzrlib.tests.test_memorytree',
3426
'bzrlib.tests.test_merge',
3427
'bzrlib.tests.test_merge3',
3428
'bzrlib.tests.test_merge_core',
3429
'bzrlib.tests.test_merge_directive',
3430
'bzrlib.tests.test_missing',
3431
'bzrlib.tests.test_msgeditor',
3432
'bzrlib.tests.test_multiparent',
3433
'bzrlib.tests.test_mutabletree',
3434
'bzrlib.tests.test_nonascii',
3435
'bzrlib.tests.test_options',
3436
'bzrlib.tests.test_osutils',
3437
'bzrlib.tests.test_osutils_encodings',
3438
'bzrlib.tests.test_pack',
3439
'bzrlib.tests.test_pack_repository',
3440
'bzrlib.tests.test_patch',
3441
'bzrlib.tests.test_patches',
3442
'bzrlib.tests.test_permissions',
3443
'bzrlib.tests.test_plugins',
3444
'bzrlib.tests.test_progress',
3445
'bzrlib.tests.test_read_bundle',
3446
'bzrlib.tests.test_reconcile',
3447
'bzrlib.tests.test_reconfigure',
3448
'bzrlib.tests.test_registry',
3449
'bzrlib.tests.test_remote',
3450
'bzrlib.tests.test_rename_map',
3451
'bzrlib.tests.test_repository',
3452
'bzrlib.tests.test_revert',
3453
'bzrlib.tests.test_revision',
3454
'bzrlib.tests.test_revisionspec',
3455
'bzrlib.tests.test_revisiontree',
3456
'bzrlib.tests.test_rio',
3457
'bzrlib.tests.test_rules',
3458
'bzrlib.tests.test_sampler',
3459
'bzrlib.tests.test_selftest',
3460
'bzrlib.tests.test_serializer',
3461
'bzrlib.tests.test_setup',
3462
'bzrlib.tests.test_sftp_transport',
3463
'bzrlib.tests.test_shelf',
3464
'bzrlib.tests.test_shelf_ui',
3465
'bzrlib.tests.test_smart',
3466
'bzrlib.tests.test_smart_add',
3467
'bzrlib.tests.test_smart_request',
3468
'bzrlib.tests.test_smart_transport',
3469
'bzrlib.tests.test_smtp_connection',
3470
'bzrlib.tests.test_source',
3471
'bzrlib.tests.test_ssh_transport',
3472
'bzrlib.tests.test_status',
3473
'bzrlib.tests.test_store',
3474
'bzrlib.tests.test_strace',
3475
'bzrlib.tests.test_subsume',
3476
'bzrlib.tests.test_switch',
3477
'bzrlib.tests.test_symbol_versioning',
3478
'bzrlib.tests.test_tag',
3479
'bzrlib.tests.test_testament',
3480
'bzrlib.tests.test_textfile',
3481
'bzrlib.tests.test_textmerge',
3482
'bzrlib.tests.test_timestamp',
3483
'bzrlib.tests.test_trace',
3484
'bzrlib.tests.test_transactions',
3485
'bzrlib.tests.test_transform',
3486
'bzrlib.tests.test_transport',
3487
'bzrlib.tests.test_transport_implementations',
3488
'bzrlib.tests.test_transport_log',
3489
'bzrlib.tests.test_tree',
3490
'bzrlib.tests.test_treebuilder',
3491
'bzrlib.tests.test_tsort',
3492
'bzrlib.tests.test_tuned_gzip',
3493
'bzrlib.tests.test_ui',
3494
'bzrlib.tests.test_uncommit',
3495
'bzrlib.tests.test_upgrade',
3496
'bzrlib.tests.test_upgrade_stacked',
3497
'bzrlib.tests.test_urlutils',
3498
'bzrlib.tests.test_version',
3499
'bzrlib.tests.test_version_info',
3500
'bzrlib.tests.test_versionedfile',
3501
'bzrlib.tests.test_weave',
3502
'bzrlib.tests.test_whitebox',
3503
'bzrlib.tests.test_win32utils',
3504
'bzrlib.tests.test_workingtree',
3505
'bzrlib.tests.test_workingtree_4',
3506
'bzrlib.tests.test_wsgi',
3507
'bzrlib.tests.test_xml',
3508
'bzrlib.tests.tree_implementations',
3509
'bzrlib.tests.workingtree_implementations',
3510
'bzrlib.util.tests.test_bencode',
3513
loader = TestUtil.TestLoader()
3516
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3517
for start in starting_with]
3518
# We take precedence over keep_only because *at loading time* using
3519
# both options means we will load less tests for the same final result.
3520
def interesting_module(name):
3521
for start in starting_with:
3523
# Either the module name starts with the specified string
3524
name.startswith(start)
3525
# or it may contain tests starting with the specified string
3526
or start.startswith(name)
3530
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3532
elif keep_only is not None:
3533
id_filter = TestIdList(keep_only)
3534
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3535
def interesting_module(name):
3536
return id_filter.refers_to(name)
3539
loader = TestUtil.TestLoader()
3540
def interesting_module(name):
3541
# No filtering, all modules are interesting
3544
suite = loader.suiteClass()
3546
# modules building their suite with loadTestsFromModuleNames
3547
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3549
modules_to_doctest = [
3551
'bzrlib.branchbuilder',
3554
'bzrlib.iterablefile',
3558
'bzrlib.symbol_versioning',
3561
'bzrlib.version_info_formats.format_custom',
3564
for mod in modules_to_doctest:
3565
if not interesting_module(mod):
3566
# No tests to keep here, move along
3569
# note that this really does mean "report only" -- doctest
3570
# still runs the rest of the examples
3571
doc_suite = doctest.DocTestSuite(mod,
3572
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3573
except ValueError, e:
3574
print '**failed to get doctest for: %s\n%s' % (mod, e)
3576
if len(doc_suite._tests) == 0:
3577
raise errors.BzrError("no doctests found in %s" % (mod,))
3578
suite.addTest(doc_suite)
3580
default_encoding = sys.getdefaultencoding()
3581
for name, plugin in bzrlib.plugin.plugins().items():
3582
if not interesting_module(plugin.module.__name__):
3584
plugin_suite = plugin.test_suite()
3585
# We used to catch ImportError here and turn it into just a warning,
3586
# but really if you don't have --no-plugins this should be a failure.
3587
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3588
if plugin_suite is None:
3589
plugin_suite = plugin.load_plugin_tests(loader)
3590
if plugin_suite is not None:
3591
suite.addTest(plugin_suite)
3592
if default_encoding != sys.getdefaultencoding():
3593
bzrlib.trace.warning(
3594
'Plugin "%s" tried to reset default encoding to: %s', name,
3595
sys.getdefaultencoding())
3597
sys.setdefaultencoding(default_encoding)
3600
suite = filter_suite_by_id_startswith(suite, starting_with)
3602
if keep_only is not None:
3603
# Now that the referred modules have loaded their tests, keep only the
3605
suite = filter_suite_by_id_list(suite, id_filter)
3606
# Do some sanity checks on the id_list filtering
3607
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3609
# The tester has used both keep_only and starting_with, so he is
3610
# already aware that some tests are excluded from the list, there
3611
# is no need to tell him which.
3614
# Some tests mentioned in the list are not in the test suite. The
3615
# list may be out of date, report to the tester.
3616
for id in not_found:
3617
bzrlib.trace.warning('"%s" not found in the test suite', id)
3618
for id in duplicates:
3619
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3624
def multiply_scenarios(scenarios_left, scenarios_right):
3625
"""Multiply two sets of scenarios.
3627
:returns: the cartesian product of the two sets of scenarios, that is
3628
a scenario for every possible combination of a left scenario and a
3632
('%s,%s' % (left_name, right_name),
3633
dict(left_dict.items() + right_dict.items()))
3634
for left_name, left_dict in scenarios_left
3635
for right_name, right_dict in scenarios_right]
3638
def multiply_tests(tests, scenarios, result):
3639
"""Multiply tests_list by scenarios into result.
3641
This is the core workhorse for test parameterisation.
3643
Typically the load_tests() method for a per-implementation test suite will
3644
call multiply_tests and return the result.
3646
:param tests: The tests to parameterise.
3647
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3648
scenario_param_dict).
3649
:param result: A TestSuite to add created tests to.
3651
This returns the passed in result TestSuite with the cross product of all
3652
the tests repeated once for each scenario. Each test is adapted by adding
3653
the scenario name at the end of its id(), and updating the test object's
3654
__dict__ with the scenario_param_dict.
3656
>>> import bzrlib.tests.test_sampler
3657
>>> r = multiply_tests(
3658
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3659
... [('one', dict(param=1)),
3660
... ('two', dict(param=2))],
3662
>>> tests = list(iter_suite_tests(r))
3666
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3672
for test in iter_suite_tests(tests):
3673
apply_scenarios(test, scenarios, result)
3677
def apply_scenarios(test, scenarios, result):
3678
"""Apply the scenarios in scenarios to test and add to result.
3680
:param test: The test to apply scenarios to.
3681
:param scenarios: An iterable of scenarios to apply to test.
3683
:seealso: apply_scenario
3685
for scenario in scenarios:
3686
result.addTest(apply_scenario(test, scenario))
3690
def apply_scenario(test, scenario):
3691
"""Copy test and apply scenario to it.
3693
:param test: A test to adapt.
3694
:param scenario: A tuple describing the scenarion.
3695
The first element of the tuple is the new test id.
3696
The second element is a dict containing attributes to set on the
3698
:return: The adapted test.
3700
new_id = "%s(%s)" % (test.id(), scenario[0])
3701
new_test = clone_test(test, new_id)
3702
for name, value in scenario[1].items():
3703
setattr(new_test, name, value)
3707
def clone_test(test, new_id):
3708
"""Clone a test giving it a new id.
3710
:param test: The test to clone.
3711
:param new_id: The id to assign to it.
3712
:return: The new test.
3714
from copy import deepcopy
3715
new_test = deepcopy(test)
3716
new_test.id = lambda: new_id
3720
def _rmtree_temp_dir(dirname):
3721
# If LANG=C we probably have created some bogus paths
3722
# which rmtree(unicode) will fail to delete
3723
# so make sure we are using rmtree(str) to delete everything
3724
# except on win32, where rmtree(str) will fail
3725
# since it doesn't have the property of byte-stream paths
3726
# (they are either ascii or mbcs)
3727
if sys.platform == 'win32':
3728
# make sure we are using the unicode win32 api
3729
dirname = unicode(dirname)
3731
dirname = dirname.encode(sys.getfilesystemencoding())
3733
osutils.rmtree(dirname)
3735
if sys.platform == 'win32' and e.errno == errno.EACCES:
3736
sys.stderr.write('Permission denied: '
3737
'unable to remove testing dir '
3739
% (os.path.basename(dirname), e))
3744
class Feature(object):
3745
"""An operating system Feature."""
3748
self._available = None
3750
def available(self):
3751
"""Is the feature available?
3753
:return: True if the feature is available.
3755
if self._available is None:
3756
self._available = self._probe()
3757
return self._available
3760
"""Implement this method in concrete features.
3762
:return: True if the feature is available.
3764
raise NotImplementedError
3767
if getattr(self, 'feature_name', None):
3768
return self.feature_name()
3769
return self.__class__.__name__
3772
class _SymlinkFeature(Feature):
3775
return osutils.has_symlinks()
3777
def feature_name(self):
3780
SymlinkFeature = _SymlinkFeature()
3783
class _HardlinkFeature(Feature):
3786
return osutils.has_hardlinks()
3788
def feature_name(self):
3791
HardlinkFeature = _HardlinkFeature()
3794
class _OsFifoFeature(Feature):
3797
return getattr(os, 'mkfifo', None)
3799
def feature_name(self):
3800
return 'filesystem fifos'
3802
OsFifoFeature = _OsFifoFeature()
3805
class _UnicodeFilenameFeature(Feature):
3806
"""Does the filesystem support Unicode filenames?"""
3810
# Check for character combinations unlikely to be covered by any
3811
# single non-unicode encoding. We use the characters
3812
# - greek small letter alpha (U+03B1) and
3813
# - braille pattern dots-123456 (U+283F).
3814
os.stat(u'\u03b1\u283f')
3815
except UnicodeEncodeError:
3817
except (IOError, OSError):
3818
# The filesystem allows the Unicode filename but the file doesn't
3822
# The filesystem allows the Unicode filename and the file exists,
3826
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3829
def probe_unicode_in_user_encoding():
3830
"""Try to encode several unicode strings to use in unicode-aware tests.
3831
Return first successfull match.
3833
:return: (unicode value, encoded plain string value) or (None, None)
3835
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3836
for uni_val in possible_vals:
3838
str_val = uni_val.encode(osutils.get_user_encoding())
3839
except UnicodeEncodeError:
3840
# Try a different character
3843
return uni_val, str_val
3847
def probe_bad_non_ascii(encoding):
3848
"""Try to find [bad] character with code [128..255]
3849
that cannot be decoded to unicode in some encoding.
3850
Return None if all non-ascii characters is valid
3853
for i in xrange(128, 256):
3856
char.decode(encoding)
3857
except UnicodeDecodeError:
3862
class _HTTPSServerFeature(Feature):
3863
"""Some tests want an https Server, check if one is available.
3865
Right now, the only way this is available is under python2.6 which provides
3876
def feature_name(self):
3877
return 'HTTPSServer'
3880
HTTPSServerFeature = _HTTPSServerFeature()
3883
class _UnicodeFilename(Feature):
3884
"""Does the filesystem support Unicode filenames?"""
3889
except UnicodeEncodeError:
3891
except (IOError, OSError):
3892
# The filesystem allows the Unicode filename but the file doesn't
3896
# The filesystem allows the Unicode filename and the file exists,
3900
UnicodeFilename = _UnicodeFilename()
3903
class _UTF8Filesystem(Feature):
3904
"""Is the filesystem UTF-8?"""
3907
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3911
UTF8Filesystem = _UTF8Filesystem()
3914
class _CaseInsCasePresFilenameFeature(Feature):
3915
"""Is the file-system case insensitive, but case-preserving?"""
3918
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3920
# first check truly case-preserving for created files, then check
3921
# case insensitive when opening existing files.
3922
name = osutils.normpath(name)
3923
base, rel = osutils.split(name)
3924
found_rel = osutils.canonical_relpath(base, name)
3925
return (found_rel == rel
3926
and os.path.isfile(name.upper())
3927
and os.path.isfile(name.lower()))
3932
def feature_name(self):
3933
return "case-insensitive case-preserving filesystem"
3935
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3938
class _CaseInsensitiveFilesystemFeature(Feature):
3939
"""Check if underlying filesystem is case-insensitive but *not* case
3942
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3943
# more likely to be case preserving, so this case is rare.
3946
if CaseInsCasePresFilenameFeature.available():
3949
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3950
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3951
TestCaseWithMemoryTransport.TEST_ROOT = root
3953
root = TestCaseWithMemoryTransport.TEST_ROOT
3954
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3956
name_a = osutils.pathjoin(tdir, 'a')
3957
name_A = osutils.pathjoin(tdir, 'A')
3959
result = osutils.isdir(name_A)
3960
_rmtree_temp_dir(tdir)
3963
def feature_name(self):
3964
return 'case-insensitive filesystem'
3966
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3969
class _SubUnitFeature(Feature):
3970
"""Check if subunit is available."""
3979
def feature_name(self):
3982
SubUnitFeature = _SubUnitFeature()
3983
# Only define SubUnitBzrRunner if subunit is available.
3985
from subunit import TestProtocolClient
3986
class SubUnitBzrRunner(TextTestRunner):
3987
def run(self, test):
3988
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
