1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
68
import bzrlib.commands
69
import bzrlib.timestamp
71
import bzrlib.inventory
72
import bzrlib.iterablefile
77
# lsprof not available
79
from bzrlib.merge import merge_inner
82
from bzrlib.smart import client, request, server
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (
92
from bzrlib.transport import get_transport
93
import bzrlib.transport
94
from bzrlib.transport.local import LocalURLServer
95
from bzrlib.transport.memory import MemoryServer
96
from bzrlib.transport.readonly import ReadonlyServer
97
from bzrlib.trace import mutter, note
98
from bzrlib.tests import TestUtil
99
from bzrlib.tests.http_server import HttpServer
100
from bzrlib.tests.TestUtil import (
104
from bzrlib.tests.treeshape import build_tree_contents
105
import bzrlib.version_info_formats.format_custom
106
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
108
# Mark this python module as being part of the implementation
109
# of unittest: this gives us better tracebacks where the last
110
# shown frame is the test code, not our assertXYZ.
113
default_transport = LocalURLServer
116
class ExtendedTestResult(unittest._TextTestResult):
117
"""Accepts, reports and accumulates the results of running tests.
119
Compared to the unittest version this class adds support for
120
profiling, benchmarking, stopping as soon as a test fails, and
121
skipping tests. There are further-specialized subclasses for
122
different types of display.
124
When a test finishes, in whatever way, it calls one of the addSuccess,
125
addFailure or addError classes. These in turn may redirect to a more
126
specific case for the special test results supported by our extended
129
Note that just one of these objects is fed the results from many tests.
134
def __init__(self, stream, descriptions, verbosity,
139
"""Construct new TestResult.
141
:param bench_history: Optionally, a writable file object to accumulate
144
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
145
if bench_history is not None:
146
from bzrlib.version import _get_bzr_source_tree
147
src_tree = _get_bzr_source_tree()
150
revision_id = src_tree.get_parent_ids()[0]
152
# XXX: if this is a brand new tree, do the same as if there
156
# XXX: If there's no branch, what should we do?
158
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
159
self._bench_history = bench_history
160
self.ui = ui.ui_factory
161
self.num_tests = num_tests
163
self.failure_count = 0
164
self.known_failure_count = 0
166
self.not_applicable_count = 0
167
self.unsupported = {}
169
self._overall_start_time = time.time()
170
self._strict = strict
174
ok = self.wasStrictlySuccessful()
176
ok = self.wasSuccessful()
178
self.stream.write('tests passed\n')
180
self.stream.write('tests failed\n')
181
if TestCase._first_thread_leaker_id:
183
'%s is leaking threads among %d leaking tests.\n' % (
184
TestCase._first_thread_leaker_id,
185
TestCase._leaking_threads_tests))
187
def _extractBenchmarkTime(self, testCase):
188
"""Add a benchmark time for the current test case."""
189
return getattr(testCase, "_benchtime", None)
191
def _elapsedTestTimeString(self):
192
"""Return a time string for the overall time the current test has taken."""
193
return self._formatTime(time.time() - self._start_time)
195
def _testTimeString(self, testCase):
196
benchmark_time = self._extractBenchmarkTime(testCase)
197
if benchmark_time is not None:
199
self._formatTime(benchmark_time),
200
self._elapsedTestTimeString())
202
return " %s" % self._elapsedTestTimeString()
204
def _formatTime(self, seconds):
205
"""Format seconds as milliseconds with leading spaces."""
206
# some benchmarks can take thousands of seconds to run, so we need 8
208
return "%8dms" % (1000 * seconds)
210
def _shortened_test_description(self, test):
212
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
215
def startTest(self, test):
216
unittest.TestResult.startTest(self, test)
219
self.report_test_start(test)
220
test.number = self.count
221
self._recordTestStartTime()
223
def startTests(self):
225
'testing: %s\n' % (osutils.realpath(sys.argv[0]),))
227
' %s (%s python%s)\n' % (
229
bzrlib.version_string,
230
bzrlib._format_version_tuple(sys.version_info),
232
self.stream.write('\n')
234
def _recordTestStartTime(self):
235
"""Record that a test has started."""
236
self._start_time = time.time()
238
def _cleanupLogFile(self, test):
239
# We can only do this if we have one of our TestCases, not if
241
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
242
if setKeepLogfile is not None:
245
def addError(self, test, err):
246
"""Tell result that test finished with an error.
248
Called from the TestCase run() method when the test
249
fails with an unexpected error.
251
self._testConcluded(test)
252
if isinstance(err[1], TestNotApplicable):
253
return self._addNotApplicable(test, err)
254
elif isinstance(err[1], UnavailableFeature):
255
return self.addNotSupported(test, err[1].args[0])
257
unittest.TestResult.addError(self, test, err)
258
self.error_count += 1
259
self.report_error(test, err)
262
self._cleanupLogFile(test)
264
def addFailure(self, test, err):
265
"""Tell result that test failed.
267
Called from the TestCase run() method when the test
268
fails because e.g. an assert() method failed.
270
self._testConcluded(test)
271
if isinstance(err[1], KnownFailure):
272
return self._addKnownFailure(test, err)
274
unittest.TestResult.addFailure(self, test, err)
275
self.failure_count += 1
276
self.report_failure(test, err)
279
self._cleanupLogFile(test)
281
def addSuccess(self, test):
282
"""Tell result that test completed successfully.
284
Called from the TestCase run()
286
self._testConcluded(test)
287
if self._bench_history is not None:
288
benchmark_time = self._extractBenchmarkTime(test)
289
if benchmark_time is not None:
290
self._bench_history.write("%s %s\n" % (
291
self._formatTime(benchmark_time),
293
self.report_success(test)
294
self._cleanupLogFile(test)
295
unittest.TestResult.addSuccess(self, test)
296
test._log_contents = ''
298
def _testConcluded(self, test):
299
"""Common code when a test has finished.
301
Called regardless of whether it succeded, failed, etc.
305
def _addKnownFailure(self, test, err):
306
self.known_failure_count += 1
307
self.report_known_failure(test, err)
309
def addNotSupported(self, test, feature):
310
"""The test will not be run because of a missing feature.
312
# this can be called in two different ways: it may be that the
313
# test started running, and then raised (through addError)
314
# UnavailableFeature. Alternatively this method can be called
315
# while probing for features before running the tests; in that
316
# case we will see startTest and stopTest, but the test will never
318
self.unsupported.setdefault(str(feature), 0)
319
self.unsupported[str(feature)] += 1
320
self.report_unsupported(test, feature)
322
def addSkip(self, test, reason):
323
"""A test has not run for 'reason'."""
325
self.report_skip(test, reason)
327
def _addNotApplicable(self, test, skip_excinfo):
328
if isinstance(skip_excinfo[1], TestNotApplicable):
329
self.not_applicable_count += 1
330
self.report_not_applicable(test, skip_excinfo)
333
except KeyboardInterrupt:
336
self.addError(test, test.exc_info())
338
# seems best to treat this as success from point-of-view of unittest
339
# -- it actually does nothing so it barely matters :)
340
unittest.TestResult.addSuccess(self, test)
341
test._log_contents = ''
343
def printErrorList(self, flavour, errors):
344
for test, err in errors:
345
self.stream.writeln(self.separator1)
346
self.stream.write("%s: " % flavour)
347
self.stream.writeln(self.getDescription(test))
348
if getattr(test, '_get_log', None) is not None:
349
self.stream.write('\n')
351
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
352
self.stream.write('\n')
353
self.stream.write(test._get_log())
354
self.stream.write('\n')
356
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
357
self.stream.write('\n')
358
self.stream.writeln(self.separator2)
359
self.stream.writeln("%s" % err)
364
def report_cleaning_up(self):
367
def report_success(self, test):
370
def wasStrictlySuccessful(self):
371
if self.unsupported or self.known_failure_count:
373
return self.wasSuccessful()
376
class TextTestResult(ExtendedTestResult):
377
"""Displays progress and results of tests in text form"""
379
def __init__(self, stream, descriptions, verbosity,
385
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
386
bench_history, num_tests, strict)
388
self.pb = self.ui.nested_progress_bar()
389
self._supplied_pb = False
392
self._supplied_pb = True
393
self.pb.show_pct = False
394
self.pb.show_spinner = False
395
self.pb.show_eta = False,
396
self.pb.show_count = False
397
self.pb.show_bar = False
399
def report_starting(self):
400
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
402
def _progress_prefix_text(self):
403
# the longer this text, the less space we have to show the test
405
a = '[%d' % self.count # total that have been run
406
# tests skipped as known not to be relevant are not important enough
408
## if self.skip_count:
409
## a += ', %d skip' % self.skip_count
410
## if self.known_failure_count:
411
## a += '+%dX' % self.known_failure_count
412
if self.num_tests is not None:
413
a +='/%d' % self.num_tests
415
runtime = time.time() - self._overall_start_time
417
a += '%dm%ds' % (runtime / 60, runtime % 60)
421
a += ', %d err' % self.error_count
422
if self.failure_count:
423
a += ', %d fail' % self.failure_count
425
a += ', %d missing' % len(self.unsupported)
429
def report_test_start(self, test):
432
self._progress_prefix_text()
434
+ self._shortened_test_description(test))
436
def _test_description(self, test):
437
return self._shortened_test_description(test)
439
def report_error(self, test, err):
440
self.pb.note('ERROR: %s\n %s\n',
441
self._test_description(test),
445
def report_failure(self, test, err):
446
self.pb.note('FAIL: %s\n %s\n',
447
self._test_description(test),
451
def report_known_failure(self, test, err):
452
self.pb.note('XFAIL: %s\n%s\n',
453
self._test_description(test), err[1])
455
def report_skip(self, test, reason):
458
def report_not_applicable(self, test, skip_excinfo):
461
def report_unsupported(self, test, feature):
462
"""test cannot be run because feature is missing."""
464
def report_cleaning_up(self):
465
self.pb.update('Cleaning up')
468
if not self._supplied_pb:
472
class VerboseTestResult(ExtendedTestResult):
473
"""Produce long output, with one line per test run plus times"""
475
def _ellipsize_to_right(self, a_string, final_width):
476
"""Truncate and pad a string, keeping the right hand side"""
477
if len(a_string) > final_width:
478
result = '...' + a_string[3-final_width:]
481
return result.ljust(final_width)
483
def report_starting(self):
484
self.stream.write('running %d tests...\n' % self.num_tests)
486
def report_test_start(self, test):
488
name = self._shortened_test_description(test)
489
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
490
# numbers, plus a trailing blank
491
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
492
self.stream.write(self._ellipsize_to_right(name,
493
osutils.terminal_width()-30))
496
def _error_summary(self, err):
498
return '%s%s' % (indent, err[1])
500
def report_error(self, test, err):
501
self.stream.writeln('ERROR %s\n%s'
502
% (self._testTimeString(test),
503
self._error_summary(err)))
505
def report_failure(self, test, err):
506
self.stream.writeln(' FAIL %s\n%s'
507
% (self._testTimeString(test),
508
self._error_summary(err)))
510
def report_known_failure(self, test, err):
511
self.stream.writeln('XFAIL %s\n%s'
512
% (self._testTimeString(test),
513
self._error_summary(err)))
515
def report_success(self, test):
516
self.stream.writeln(' OK %s' % self._testTimeString(test))
517
for bench_called, stats in getattr(test, '_benchcalls', []):
518
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
519
stats.pprint(file=self.stream)
520
# flush the stream so that we get smooth output. This verbose mode is
521
# used to show the output in PQM.
524
def report_skip(self, test, reason):
525
self.stream.writeln(' SKIP %s\n%s'
526
% (self._testTimeString(test), reason))
528
def report_not_applicable(self, test, skip_excinfo):
529
self.stream.writeln(' N/A %s\n%s'
530
% (self._testTimeString(test),
531
self._error_summary(skip_excinfo)))
533
def report_unsupported(self, test, feature):
534
"""test cannot be run because feature is missing."""
535
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
536
%(self._testTimeString(test), feature))
539
class TextTestRunner(object):
540
stop_on_failure = False
550
self.stream = unittest._WritelnDecorator(stream)
551
self.descriptions = descriptions
552
self.verbosity = verbosity
553
self._bench_history = bench_history
554
self.list_only = list_only
555
self._strict = strict
558
"Run the given test case or test suite."
559
startTime = time.time()
560
if self.verbosity == 1:
561
result_class = TextTestResult
562
elif self.verbosity >= 2:
563
result_class = VerboseTestResult
564
result = result_class(self.stream,
567
bench_history=self._bench_history,
568
num_tests=test.countTestCases(),
571
result.stop_early = self.stop_on_failure
572
result.report_starting()
574
if self.verbosity >= 2:
575
self.stream.writeln("Listing tests only ...\n")
577
for t in iter_suite_tests(test):
578
self.stream.writeln("%s" % (t.id()))
587
if isinstance(test, testtools.ConcurrentTestSuite):
588
# We need to catch bzr specific behaviors
589
test.run(BZRTransformingResult(result))
592
run = result.testsRun
594
stopTime = time.time()
595
timeTaken = stopTime - startTime
597
self.stream.writeln(result.separator2)
598
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
599
run, run != 1 and "s" or "", timeTaken))
600
self.stream.writeln()
601
if not result.wasSuccessful():
602
self.stream.write("FAILED (")
603
failed, errored = map(len, (result.failures, result.errors))
605
self.stream.write("failures=%d" % failed)
607
if failed: self.stream.write(", ")
608
self.stream.write("errors=%d" % errored)
609
if result.known_failure_count:
610
if failed or errored: self.stream.write(", ")
611
self.stream.write("known_failure_count=%d" %
612
result.known_failure_count)
613
self.stream.writeln(")")
615
if result.known_failure_count:
616
self.stream.writeln("OK (known_failures=%d)" %
617
result.known_failure_count)
619
self.stream.writeln("OK")
620
if result.skip_count > 0:
621
skipped = result.skip_count
622
self.stream.writeln('%d test%s skipped' %
623
(skipped, skipped != 1 and "s" or ""))
624
if result.unsupported:
625
for feature, count in sorted(result.unsupported.items()):
626
self.stream.writeln("Missing feature '%s' skipped %d tests." %
632
def iter_suite_tests(suite):
633
"""Return all tests in a suite, recursing through nested suites"""
634
if isinstance(suite, unittest.TestCase):
636
elif isinstance(suite, unittest.TestSuite):
638
for r in iter_suite_tests(item):
641
raise Exception('unknown type %r for object %r'
642
% (type(suite), suite))
645
class TestSkipped(Exception):
646
"""Indicates that a test was intentionally skipped, rather than failing."""
649
class TestNotApplicable(TestSkipped):
650
"""A test is not applicable to the situation where it was run.
652
This is only normally raised by parameterized tests, if they find that
653
the instance they're constructed upon does not support one aspect
658
class KnownFailure(AssertionError):
659
"""Indicates that a test failed in a precisely expected manner.
661
Such failures dont block the whole test suite from passing because they are
662
indicators of partially completed code or of future work. We have an
663
explicit error for them so that we can ensure that they are always visible:
664
KnownFailures are always shown in the output of bzr selftest.
668
class UnavailableFeature(Exception):
669
"""A feature required for this test was not available.
671
The feature should be used to construct the exception.
675
class CommandFailed(Exception):
679
class StringIOWrapper(object):
680
"""A wrapper around cStringIO which just adds an encoding attribute.
682
Internally we can check sys.stdout to see what the output encoding
683
should be. However, cStringIO has no encoding attribute that we can
684
set. So we wrap it instead.
689
def __init__(self, s=None):
691
self.__dict__['_cstring'] = StringIO(s)
693
self.__dict__['_cstring'] = StringIO()
695
def __getattr__(self, name, getattr=getattr):
696
return getattr(self.__dict__['_cstring'], name)
698
def __setattr__(self, name, val):
699
if name == 'encoding':
700
self.__dict__['encoding'] = val
702
return setattr(self._cstring, name, val)
705
class TestUIFactory(ui.CLIUIFactory):
706
"""A UI Factory for testing.
708
Hide the progress bar but emit note()s.
710
Allows get_password to be tested without real tty attached.
713
def __init__(self, stdout=None, stderr=None, stdin=None):
714
if stdin is not None:
715
# We use a StringIOWrapper to be able to test various
716
# encodings, but the user is still responsible to
717
# encode the string and to set the encoding attribute
718
# of StringIOWrapper.
719
stdin = StringIOWrapper(stdin)
720
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
723
"""See progress.ProgressBar.clear()."""
725
def clear_term(self):
726
"""See progress.ProgressBar.clear_term()."""
729
"""See progress.ProgressBar.finished()."""
731
def note(self, fmt_string, *args, **kwargs):
732
"""See progress.ProgressBar.note()."""
733
self.stdout.write((fmt_string + "\n") % args)
735
def progress_bar(self):
738
def nested_progress_bar(self):
741
def update(self, message, count=None, total=None):
742
"""See progress.ProgressBar.update()."""
744
def get_non_echoed_password(self):
745
"""Get password from stdin without trying to handle the echo mode"""
746
password = self.stdin.readline()
749
if password[-1] == '\n':
750
password = password[:-1]
754
class TestCase(unittest.TestCase):
755
"""Base class for bzr unit tests.
757
Tests that need access to disk resources should subclass
758
TestCaseInTempDir not TestCase.
760
Error and debug log messages are redirected from their usual
761
location into a temporary file, the contents of which can be
762
retrieved by _get_log(). We use a real OS file, not an in-memory object,
763
so that it can also capture file IO. When the test completes this file
764
is read into memory and removed from disk.
766
There are also convenience functions to invoke bzr's command-line
767
routine, and to build and check bzr trees.
769
In addition to the usual method of overriding tearDown(), this class also
770
allows subclasses to register functions into the _cleanups list, which is
771
run in order as the object is torn down. It's less likely this will be
772
accidentally overlooked.
775
_active_threads = None
776
_leaking_threads_tests = 0
777
_first_thread_leaker_id = None
778
_log_file_name = None
780
_keep_log_file = False
781
# record lsprof data when performing benchmark calls.
782
_gather_lsprof_in_benchmarks = False
783
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
784
'_log_contents', '_log_file_name', '_benchtime',
785
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
787
def __init__(self, methodName='testMethod'):
788
super(TestCase, self).__init__(methodName)
790
self._bzr_test_setUp_run = False
791
self._bzr_test_tearDown_run = False
794
unittest.TestCase.setUp(self)
795
self._bzr_test_setUp_run = True
796
self._cleanEnvironment()
799
self._benchcalls = []
800
self._benchtime = None
802
# Track locks - needs to be called before _clear_debug_flags.
804
self._clear_debug_flags()
805
TestCase._active_threads = threading.activeCount()
806
self.addCleanup(self._check_leaked_threads)
811
pdb.Pdb().set_trace(sys._getframe().f_back)
813
def _check_leaked_threads(self):
814
active = threading.activeCount()
815
leaked_threads = active - TestCase._active_threads
816
TestCase._active_threads = active
818
TestCase._leaking_threads_tests += 1
819
if TestCase._first_thread_leaker_id is None:
820
TestCase._first_thread_leaker_id = self.id()
822
def _clear_debug_flags(self):
823
"""Prevent externally set debug flags affecting tests.
825
Tests that want to use debug flags can just set them in the
826
debug_flags set during setup/teardown.
828
self._preserved_debug_flags = set(debug.debug_flags)
829
if 'allow_debug' not in selftest_debug_flags:
830
debug.debug_flags.clear()
831
self.addCleanup(self._restore_debug_flags)
833
def _clear_hooks(self):
834
# prevent hooks affecting tests
835
self._preserved_hooks = {}
836
for key, factory in hooks.known_hooks.items():
837
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
838
current_hooks = hooks.known_hooks_key_to_object(key)
839
self._preserved_hooks[parent] = (name, current_hooks)
840
self.addCleanup(self._restoreHooks)
841
for key, factory in hooks.known_hooks.items():
842
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
843
setattr(parent, name, factory())
844
# this hook should always be installed
845
request._install_hook()
847
def _silenceUI(self):
848
"""Turn off UI for duration of test"""
849
# by default the UI is off; tests can turn it on if they want it.
850
saved = ui.ui_factory
852
ui.ui_factory = saved
853
ui.ui_factory = ui.SilentUIFactory()
854
self.addCleanup(_restore)
856
def _check_locks(self):
857
"""Check that all lock take/release actions have been paired."""
858
# once we have fixed all the current lock problems, we can change the
859
# following code to always check for mismatched locks, but only do
860
# traceback showing with -Dlock (self._lock_check_thorough is True).
861
# For now, because the test suite will fail, we only assert that lock
862
# matching has occured with -Dlock.
864
acquired_locks = [lock for action, lock in self._lock_actions
865
if action == 'acquired']
866
released_locks = [lock for action, lock in self._lock_actions
867
if action == 'released']
868
# 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
for attr_name in self.attrs_to_keep:
1450
if attr_name in self.__dict__:
1451
saved_attrs[attr_name] = self.__dict__[attr_name]
1452
self.__dict__ = saved_attrs
1456
self._log_contents = ''
1457
self._bzr_test_tearDown_run = True
1458
unittest.TestCase.tearDown(self)
1460
def time(self, callable, *args, **kwargs):
1461
"""Run callable and accrue the time it takes to the benchmark time.
1463
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1464
this will cause lsprofile statistics to be gathered and stored in
1467
if self._benchtime is None:
1471
if not self._gather_lsprof_in_benchmarks:
1472
return callable(*args, **kwargs)
1474
# record this benchmark
1475
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1477
self._benchcalls.append(((callable, args, kwargs), stats))
1480
self._benchtime += time.time() - start
1482
def _runCleanups(self):
1483
"""Run registered cleanup functions.
1485
This should only be called from TestCase.tearDown.
1487
# TODO: Perhaps this should keep running cleanups even if
1488
# one of them fails?
1490
# Actually pop the cleanups from the list so tearDown running
1491
# twice is safe (this happens for skipped tests).
1492
while self._cleanups:
1493
cleanup, args, kwargs = self._cleanups.pop()
1494
cleanup(*args, **kwargs)
1496
def log(self, *args):
1499
def _get_log(self, keep_log_file=False):
1500
"""Get the log from bzrlib.trace calls from this test.
1502
:param keep_log_file: When True, if the log is still a file on disk
1503
leave it as a file on disk. When False, if the log is still a file
1504
on disk, the log file is deleted and the log preserved as
1506
:return: A string containing the log.
1508
# flush the log file, to get all content
1510
if bzrlib.trace._trace_file:
1511
bzrlib.trace._trace_file.flush()
1512
if self._log_contents:
1513
# XXX: this can hardly contain the content flushed above --vila
1515
return self._log_contents
1516
if self._log_file_name is not None:
1517
logfile = open(self._log_file_name)
1519
log_contents = logfile.read()
1522
if not keep_log_file:
1523
self._log_contents = log_contents
1525
os.remove(self._log_file_name)
1527
if sys.platform == 'win32' and e.errno == errno.EACCES:
1528
sys.stderr.write(('Unable to delete log file '
1529
' %r\n' % self._log_file_name))
1534
return "DELETED log file to reduce memory footprint"
1536
def requireFeature(self, feature):
1537
"""This test requires a specific feature is available.
1539
:raises UnavailableFeature: When feature is not available.
1541
if not feature.available():
1542
raise UnavailableFeature(feature)
1544
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1546
"""Run bazaar command line, splitting up a string command line."""
1547
if isinstance(args, basestring):
1548
# shlex don't understand unicode strings,
1549
# so args should be plain string (bialix 20070906)
1550
args = list(shlex.split(str(args)))
1551
return self._run_bzr_core(args, retcode=retcode,
1552
encoding=encoding, stdin=stdin, working_dir=working_dir,
1555
def _run_bzr_core(self, args, retcode, encoding, stdin,
1557
if encoding is None:
1558
encoding = osutils.get_user_encoding()
1559
stdout = StringIOWrapper()
1560
stderr = StringIOWrapper()
1561
stdout.encoding = encoding
1562
stderr.encoding = encoding
1564
self.log('run bzr: %r', args)
1565
# FIXME: don't call into logging here
1566
handler = logging.StreamHandler(stderr)
1567
handler.setLevel(logging.INFO)
1568
logger = logging.getLogger('')
1569
logger.addHandler(handler)
1570
old_ui_factory = ui.ui_factory
1571
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1574
if working_dir is not None:
1575
cwd = osutils.getcwd()
1576
os.chdir(working_dir)
1579
result = self.apply_redirected(ui.ui_factory.stdin,
1581
bzrlib.commands.run_bzr_catch_user_errors,
1584
logger.removeHandler(handler)
1585
ui.ui_factory = old_ui_factory
1589
out = stdout.getvalue()
1590
err = stderr.getvalue()
1592
self.log('output:\n%r', out)
1594
self.log('errors:\n%r', err)
1595
if retcode is not None:
1596
self.assertEquals(retcode, result,
1597
message='Unexpected return code')
1600
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1601
working_dir=None, error_regexes=[], output_encoding=None):
1602
"""Invoke bzr, as if it were run from the command line.
1604
The argument list should not include the bzr program name - the
1605
first argument is normally the bzr command. Arguments may be
1606
passed in three ways:
1608
1- A list of strings, eg ["commit", "a"]. This is recommended
1609
when the command contains whitespace or metacharacters, or
1610
is built up at run time.
1612
2- A single string, eg "add a". This is the most convenient
1613
for hardcoded commands.
1615
This runs bzr through the interface that catches and reports
1616
errors, and with logging set to something approximating the
1617
default, so that error reporting can be checked.
1619
This should be the main method for tests that want to exercise the
1620
overall behavior of the bzr application (rather than a unit test
1621
or a functional test of the library.)
1623
This sends the stdout/stderr results into the test's log,
1624
where it may be useful for debugging. See also run_captured.
1626
:keyword stdin: A string to be used as stdin for the command.
1627
:keyword retcode: The status code the command should return;
1629
:keyword working_dir: The directory to run the command in
1630
:keyword error_regexes: A list of expected error messages. If
1631
specified they must be seen in the error output of the command.
1633
out, err = self._run_bzr_autosplit(
1638
working_dir=working_dir,
1640
for regex in error_regexes:
1641
self.assertContainsRe(err, regex)
1644
def run_bzr_error(self, error_regexes, *args, **kwargs):
1645
"""Run bzr, and check that stderr contains the supplied regexes
1647
:param error_regexes: Sequence of regular expressions which
1648
must each be found in the error output. The relative ordering
1650
:param args: command-line arguments for bzr
1651
:param kwargs: Keyword arguments which are interpreted by run_bzr
1652
This function changes the default value of retcode to be 3,
1653
since in most cases this is run when you expect bzr to fail.
1655
:return: (out, err) The actual output of running the command (in case
1656
you want to do more inspection)
1660
# Make sure that commit is failing because there is nothing to do
1661
self.run_bzr_error(['no changes to commit'],
1662
['commit', '-m', 'my commit comment'])
1663
# Make sure --strict is handling an unknown file, rather than
1664
# giving us the 'nothing to do' error
1665
self.build_tree(['unknown'])
1666
self.run_bzr_error(['Commit refused because there are unknown files'],
1667
['commit', --strict', '-m', 'my commit comment'])
1669
kwargs.setdefault('retcode', 3)
1670
kwargs['error_regexes'] = error_regexes
1671
out, err = self.run_bzr(*args, **kwargs)
1674
def run_bzr_subprocess(self, *args, **kwargs):
1675
"""Run bzr in a subprocess for testing.
1677
This starts a new Python interpreter and runs bzr in there.
1678
This should only be used for tests that have a justifiable need for
1679
this isolation: e.g. they are testing startup time, or signal
1680
handling, or early startup code, etc. Subprocess code can't be
1681
profiled or debugged so easily.
1683
:keyword retcode: The status code that is expected. Defaults to 0. If
1684
None is supplied, the status code is not checked.
1685
:keyword env_changes: A dictionary which lists changes to environment
1686
variables. A value of None will unset the env variable.
1687
The values must be strings. The change will only occur in the
1688
child, so you don't need to fix the environment after running.
1689
:keyword universal_newlines: Convert CRLF => LF
1690
:keyword allow_plugins: By default the subprocess is run with
1691
--no-plugins to ensure test reproducibility. Also, it is possible
1692
for system-wide plugins to create unexpected output on stderr,
1693
which can cause unnecessary test failures.
1695
env_changes = kwargs.get('env_changes', {})
1696
working_dir = kwargs.get('working_dir', None)
1697
allow_plugins = kwargs.get('allow_plugins', False)
1699
if isinstance(args[0], list):
1701
elif isinstance(args[0], basestring):
1702
args = list(shlex.split(args[0]))
1704
raise ValueError("passing varargs to run_bzr_subprocess")
1705
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1706
working_dir=working_dir,
1707
allow_plugins=allow_plugins)
1708
# We distinguish between retcode=None and retcode not passed.
1709
supplied_retcode = kwargs.get('retcode', 0)
1710
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1711
universal_newlines=kwargs.get('universal_newlines', False),
1714
def start_bzr_subprocess(self, process_args, env_changes=None,
1715
skip_if_plan_to_signal=False,
1717
allow_plugins=False):
1718
"""Start bzr in a subprocess for testing.
1720
This starts a new Python interpreter and runs bzr in there.
1721
This should only be used for tests that have a justifiable need for
1722
this isolation: e.g. they are testing startup time, or signal
1723
handling, or early startup code, etc. Subprocess code can't be
1724
profiled or debugged so easily.
1726
:param process_args: a list of arguments to pass to the bzr executable,
1727
for example ``['--version']``.
1728
:param env_changes: A dictionary which lists changes to environment
1729
variables. A value of None will unset the env variable.
1730
The values must be strings. The change will only occur in the
1731
child, so you don't need to fix the environment after running.
1732
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1734
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1736
:returns: Popen object for the started process.
1738
if skip_if_plan_to_signal:
1739
if not getattr(os, 'kill', None):
1740
raise TestSkipped("os.kill not available.")
1742
if env_changes is None:
1746
def cleanup_environment():
1747
for env_var, value in env_changes.iteritems():
1748
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1750
def restore_environment():
1751
for env_var, value in old_env.iteritems():
1752
osutils.set_or_unset_env(env_var, value)
1754
bzr_path = self.get_bzr_path()
1757
if working_dir is not None:
1758
cwd = osutils.getcwd()
1759
os.chdir(working_dir)
1762
# win32 subprocess doesn't support preexec_fn
1763
# so we will avoid using it on all platforms, just to
1764
# make sure the code path is used, and we don't break on win32
1765
cleanup_environment()
1766
command = [sys.executable]
1767
# frozen executables don't need the path to bzr
1768
if getattr(sys, "frozen", None) is None:
1769
command.append(bzr_path)
1770
if not allow_plugins:
1771
command.append('--no-plugins')
1772
command.extend(process_args)
1773
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1775
restore_environment()
1781
def _popen(self, *args, **kwargs):
1782
"""Place a call to Popen.
1784
Allows tests to override this method to intercept the calls made to
1785
Popen for introspection.
1787
return Popen(*args, **kwargs)
1789
def get_bzr_path(self):
1790
"""Return the path of the 'bzr' executable for this test suite."""
1791
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1792
if not os.path.isfile(bzr_path):
1793
# We are probably installed. Assume sys.argv is the right file
1794
bzr_path = sys.argv[0]
1797
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1798
universal_newlines=False, process_args=None):
1799
"""Finish the execution of process.
1801
:param process: the Popen object returned from start_bzr_subprocess.
1802
:param retcode: The status code that is expected. Defaults to 0. If
1803
None is supplied, the status code is not checked.
1804
:param send_signal: an optional signal to send to the process.
1805
:param universal_newlines: Convert CRLF => LF
1806
:returns: (stdout, stderr)
1808
if send_signal is not None:
1809
os.kill(process.pid, send_signal)
1810
out, err = process.communicate()
1812
if universal_newlines:
1813
out = out.replace('\r\n', '\n')
1814
err = err.replace('\r\n', '\n')
1816
if retcode is not None and retcode != process.returncode:
1817
if process_args is None:
1818
process_args = "(unknown args)"
1819
mutter('Output of bzr %s:\n%s', process_args, out)
1820
mutter('Error for bzr %s:\n%s', process_args, err)
1821
self.fail('Command bzr %s failed with retcode %s != %s'
1822
% (process_args, retcode, process.returncode))
1825
def check_inventory_shape(self, inv, shape):
1826
"""Compare an inventory to a list of expected names.
1828
Fail if they are not precisely equal.
1831
shape = list(shape) # copy
1832
for path, ie in inv.entries():
1833
name = path.replace('\\', '/')
1834
if ie.kind == 'directory':
1841
self.fail("expected paths not found in inventory: %r" % shape)
1843
self.fail("unexpected paths found in inventory: %r" % extras)
1845
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1846
a_callable=None, *args, **kwargs):
1847
"""Call callable with redirected std io pipes.
1849
Returns the return code."""
1850
if not callable(a_callable):
1851
raise ValueError("a_callable must be callable.")
1853
stdin = StringIO("")
1855
if getattr(self, "_log_file", None) is not None:
1856
stdout = self._log_file
1860
if getattr(self, "_log_file", None is not None):
1861
stderr = self._log_file
1864
real_stdin = sys.stdin
1865
real_stdout = sys.stdout
1866
real_stderr = sys.stderr
1871
return a_callable(*args, **kwargs)
1873
sys.stdout = real_stdout
1874
sys.stderr = real_stderr
1875
sys.stdin = real_stdin
1877
def reduceLockdirTimeout(self):
1878
"""Reduce the default lock timeout for the duration of the test, so that
1879
if LockContention occurs during a test, it does so quickly.
1881
Tests that expect to provoke LockContention errors should call this.
1883
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1885
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1886
self.addCleanup(resetTimeout)
1887
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1889
def make_utf8_encoded_stringio(self, encoding_type=None):
1890
"""Return a StringIOWrapper instance, that will encode Unicode
1893
if encoding_type is None:
1894
encoding_type = 'strict'
1896
output_encoding = 'utf-8'
1897
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1898
sio.encoding = output_encoding
1902
class CapturedCall(object):
1903
"""A helper for capturing smart server calls for easy debug analysis."""
1905
def __init__(self, params, prefix_length):
1906
"""Capture the call with params and skip prefix_length stack frames."""
1909
# The last 5 frames are the __init__, the hook frame, and 3 smart
1910
# client frames. Beyond this we could get more clever, but this is good
1912
stack = traceback.extract_stack()[prefix_length:-5]
1913
self.stack = ''.join(traceback.format_list(stack))
1916
return self.call.method
1919
return self.call.method
1925
class TestCaseWithMemoryTransport(TestCase):
1926
"""Common test class for tests that do not need disk resources.
1928
Tests that need disk resources should derive from TestCaseWithTransport.
1930
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1932
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1933
a directory which does not exist. This serves to help ensure test isolation
1934
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1935
must exist. However, TestCaseWithMemoryTransport does not offer local
1936
file defaults for the transport in tests, nor does it obey the command line
1937
override, so tests that accidentally write to the common directory should
1940
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1941
a .bzr directory that stops us ascending higher into the filesystem.
1947
def __init__(self, methodName='runTest'):
1948
# allow test parameterization after test construction and before test
1949
# execution. Variables that the parameterizer sets need to be
1950
# ones that are not set by setUp, or setUp will trash them.
1951
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1952
self.vfs_transport_factory = default_transport
1953
self.transport_server = None
1954
self.transport_readonly_server = None
1955
self.__vfs_server = None
1957
def get_transport(self, relpath=None):
1958
"""Return a writeable transport.
1960
This transport is for the test scratch space relative to
1963
:param relpath: a path relative to the base url.
1965
t = get_transport(self.get_url(relpath))
1966
self.assertFalse(t.is_readonly())
1969
def get_readonly_transport(self, relpath=None):
1970
"""Return a readonly transport for the test scratch space
1972
This can be used to test that operations which should only need
1973
readonly access in fact do not try to write.
1975
:param relpath: a path relative to the base url.
1977
t = get_transport(self.get_readonly_url(relpath))
1978
self.assertTrue(t.is_readonly())
1981
def create_transport_readonly_server(self):
1982
"""Create a transport server from class defined at init.
1984
This is mostly a hook for daughter classes.
1986
return self.transport_readonly_server()
1988
def get_readonly_server(self):
1989
"""Get the server instance for the readonly transport
1991
This is useful for some tests with specific servers to do diagnostics.
1993
if self.__readonly_server is None:
1994
if self.transport_readonly_server is None:
1995
# readonly decorator requested
1996
# bring up the server
1997
self.__readonly_server = ReadonlyServer()
1998
self.__readonly_server.setUp(self.get_vfs_only_server())
2000
self.__readonly_server = self.create_transport_readonly_server()
2001
self.__readonly_server.setUp(self.get_vfs_only_server())
2002
self.addCleanup(self.__readonly_server.tearDown)
2003
return self.__readonly_server
2005
def get_readonly_url(self, relpath=None):
2006
"""Get a URL for the readonly transport.
2008
This will either be backed by '.' or a decorator to the transport
2009
used by self.get_url()
2010
relpath provides for clients to get a path relative to the base url.
2011
These should only be downwards relative, not upwards.
2013
base = self.get_readonly_server().get_url()
2014
return self._adjust_url(base, relpath)
2016
def get_vfs_only_server(self):
2017
"""Get the vfs only read/write server instance.
2019
This is useful for some tests with specific servers that need
2022
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2023
is no means to override it.
2025
if self.__vfs_server is None:
2026
self.__vfs_server = MemoryServer()
2027
self.__vfs_server.setUp()
2028
self.addCleanup(self.__vfs_server.tearDown)
2029
return self.__vfs_server
2031
def get_server(self):
2032
"""Get the read/write server instance.
2034
This is useful for some tests with specific servers that need
2037
This is built from the self.transport_server factory. If that is None,
2038
then the self.get_vfs_server is returned.
2040
if self.__server is None:
2041
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2042
return self.get_vfs_only_server()
2044
# bring up a decorated means of access to the vfs only server.
2045
self.__server = self.transport_server()
2047
self.__server.setUp(self.get_vfs_only_server())
2048
except TypeError, e:
2049
# This should never happen; the try:Except here is to assist
2050
# developers having to update code rather than seeing an
2051
# uninformative TypeError.
2052
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2053
self.addCleanup(self.__server.tearDown)
2054
return self.__server
2056
def _adjust_url(self, base, relpath):
2057
"""Get a URL (or maybe a path) for the readwrite transport.
2059
This will either be backed by '.' or to an equivalent non-file based
2061
relpath provides for clients to get a path relative to the base url.
2062
These should only be downwards relative, not upwards.
2064
if relpath is not None and relpath != '.':
2065
if not base.endswith('/'):
2067
# XXX: Really base should be a url; we did after all call
2068
# get_url()! But sometimes it's just a path (from
2069
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2070
# to a non-escaped local path.
2071
if base.startswith('./') or base.startswith('/'):
2074
base += urlutils.escape(relpath)
2077
def get_url(self, relpath=None):
2078
"""Get a URL (or maybe a path) for the readwrite transport.
2080
This will either be backed by '.' or to an equivalent non-file based
2082
relpath provides for clients to get a path relative to the base url.
2083
These should only be downwards relative, not upwards.
2085
base = self.get_server().get_url()
2086
return self._adjust_url(base, relpath)
2088
def get_vfs_only_url(self, relpath=None):
2089
"""Get a URL (or maybe a path for the plain old vfs transport.
2091
This will never be a smart protocol. It always has all the
2092
capabilities of the local filesystem, but it might actually be a
2093
MemoryTransport or some other similar virtual filesystem.
2095
This is the backing transport (if any) of the server returned by
2096
get_url and get_readonly_url.
2098
:param relpath: provides for clients to get a path relative to the base
2099
url. These should only be downwards relative, not upwards.
2102
base = self.get_vfs_only_server().get_url()
2103
return self._adjust_url(base, relpath)
2105
def _create_safety_net(self):
2106
"""Make a fake bzr directory.
2108
This prevents any tests propagating up onto the TEST_ROOT directory's
2111
root = TestCaseWithMemoryTransport.TEST_ROOT
2112
bzrdir.BzrDir.create_standalone_workingtree(root)
2114
def _check_safety_net(self):
2115
"""Check that the safety .bzr directory have not been touched.
2117
_make_test_root have created a .bzr directory to prevent tests from
2118
propagating. This method ensures than a test did not leaked.
2120
root = TestCaseWithMemoryTransport.TEST_ROOT
2121
wt = workingtree.WorkingTree.open(root)
2122
last_rev = wt.last_revision()
2123
if last_rev != 'null:':
2124
# The current test have modified the /bzr directory, we need to
2125
# recreate a new one or all the followng tests will fail.
2126
# If you need to inspect its content uncomment the following line
2127
# import pdb; pdb.set_trace()
2128
_rmtree_temp_dir(root + '/.bzr')
2129
self._create_safety_net()
2130
raise AssertionError('%s/.bzr should not be modified' % root)
2132
def _make_test_root(self):
2133
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2134
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2135
TestCaseWithMemoryTransport.TEST_ROOT = root
2137
self._create_safety_net()
2139
# The same directory is used by all tests, and we're not
2140
# specifically told when all tests are finished. This will do.
2141
atexit.register(_rmtree_temp_dir, root)
2143
self.addCleanup(self._check_safety_net)
2145
def makeAndChdirToTestDir(self):
2146
"""Create a temporary directories for this one test.
2148
This must set self.test_home_dir and self.test_dir and chdir to
2151
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2153
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2154
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2155
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2157
def make_branch(self, relpath, format=None):
2158
"""Create a branch on the transport at relpath."""
2159
repo = self.make_repository(relpath, format=format)
2160
return repo.bzrdir.create_branch()
2162
def make_bzrdir(self, relpath, format=None):
2164
# might be a relative or absolute path
2165
maybe_a_url = self.get_url(relpath)
2166
segments = maybe_a_url.rsplit('/', 1)
2167
t = get_transport(maybe_a_url)
2168
if len(segments) > 1 and segments[-1] not in ('', '.'):
2172
if isinstance(format, basestring):
2173
format = bzrdir.format_registry.make_bzrdir(format)
2174
return format.initialize_on_transport(t)
2175
except errors.UninitializableFormat:
2176
raise TestSkipped("Format %s is not initializable." % format)
2178
def make_repository(self, relpath, shared=False, format=None):
2179
"""Create a repository on our default transport at relpath.
2181
Note that relpath must be a relative path, not a full url.
2183
# FIXME: If you create a remoterepository this returns the underlying
2184
# real format, which is incorrect. Actually we should make sure that
2185
# RemoteBzrDir returns a RemoteRepository.
2186
# maybe mbp 20070410
2187
made_control = self.make_bzrdir(relpath, format=format)
2188
return made_control.create_repository(shared=shared)
2190
def make_smart_server(self, path):
2191
smart_server = server.SmartTCPServer_for_testing()
2192
smart_server.setUp(self.get_server())
2193
remote_transport = get_transport(smart_server.get_url()).clone(path)
2194
self.addCleanup(smart_server.tearDown)
2195
return remote_transport
2197
def make_branch_and_memory_tree(self, relpath, format=None):
2198
"""Create a branch on the default transport and a MemoryTree for it."""
2199
b = self.make_branch(relpath, format=format)
2200
return memorytree.MemoryTree.create_on_branch(b)
2202
def make_branch_builder(self, relpath, format=None):
2203
branch = self.make_branch(relpath, format=format)
2204
return branchbuilder.BranchBuilder(branch=branch)
2206
def overrideEnvironmentForTesting(self):
2207
os.environ['HOME'] = self.test_home_dir
2208
os.environ['BZR_HOME'] = self.test_home_dir
2211
super(TestCaseWithMemoryTransport, self).setUp()
2212
self._make_test_root()
2213
_currentdir = os.getcwdu()
2214
def _leaveDirectory():
2215
os.chdir(_currentdir)
2216
self.addCleanup(_leaveDirectory)
2217
self.makeAndChdirToTestDir()
2218
self.overrideEnvironmentForTesting()
2219
self.__readonly_server = None
2220
self.__server = None
2221
self.reduceLockdirTimeout()
2223
def setup_smart_server_with_call_log(self):
2224
"""Sets up a smart server as the transport server with a call log."""
2225
self.transport_server = server.SmartTCPServer_for_testing
2226
self.hpss_calls = []
2228
# Skip the current stack down to the caller of
2229
# setup_smart_server_with_call_log
2230
prefix_length = len(traceback.extract_stack()) - 2
2231
def capture_hpss_call(params):
2232
self.hpss_calls.append(
2233
CapturedCall(params, prefix_length))
2234
client._SmartClient.hooks.install_named_hook(
2235
'call', capture_hpss_call, None)
2237
def reset_smart_call_log(self):
2238
self.hpss_calls = []
2241
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2242
"""Derived class that runs a test within a temporary directory.
2244
This is useful for tests that need to create a branch, etc.
2246
The directory is created in a slightly complex way: for each
2247
Python invocation, a new temporary top-level directory is created.
2248
All test cases create their own directory within that. If the
2249
tests complete successfully, the directory is removed.
2251
:ivar test_base_dir: The path of the top-level directory for this
2252
test, which contains a home directory and a work directory.
2254
:ivar test_home_dir: An initially empty directory under test_base_dir
2255
which is used as $HOME for this test.
2257
:ivar test_dir: A directory under test_base_dir used as the current
2258
directory when the test proper is run.
2261
OVERRIDE_PYTHON = 'python'
2263
def check_file_contents(self, filename, expect):
2264
self.log("check contents of file %s" % filename)
2265
contents = file(filename, 'r').read()
2266
if contents != expect:
2267
self.log("expected: %r" % expect)
2268
self.log("actually: %r" % contents)
2269
self.fail("contents of %s not as expected" % filename)
2271
def _getTestDirPrefix(self):
2272
# create a directory within the top level test directory
2273
if sys.platform == 'win32':
2274
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2275
# windows is likely to have path-length limits so use a short name
2276
name_prefix = name_prefix[-30:]
2278
name_prefix = re.sub('[/]', '_', self.id())
2281
def makeAndChdirToTestDir(self):
2282
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2284
For TestCaseInTempDir we create a temporary directory based on the test
2285
name and then create two subdirs - test and home under it.
2287
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2288
self._getTestDirPrefix())
2290
for i in range(100):
2291
if os.path.exists(name):
2292
name = name_prefix + '_' + str(i)
2296
# now create test and home directories within this dir
2297
self.test_base_dir = name
2298
self.test_home_dir = self.test_base_dir + '/home'
2299
os.mkdir(self.test_home_dir)
2300
self.test_dir = self.test_base_dir + '/work'
2301
os.mkdir(self.test_dir)
2302
os.chdir(self.test_dir)
2303
# put name of test inside
2304
f = file(self.test_base_dir + '/name', 'w')
2309
self.addCleanup(self.deleteTestDir)
2311
def deleteTestDir(self):
2312
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2313
_rmtree_temp_dir(self.test_base_dir)
2315
def build_tree(self, shape, line_endings='binary', transport=None):
2316
"""Build a test tree according to a pattern.
2318
shape is a sequence of file specifications. If the final
2319
character is '/', a directory is created.
2321
This assumes that all the elements in the tree being built are new.
2323
This doesn't add anything to a branch.
2325
:type shape: list or tuple.
2326
:param line_endings: Either 'binary' or 'native'
2327
in binary mode, exact contents are written in native mode, the
2328
line endings match the default platform endings.
2329
:param transport: A transport to write to, for building trees on VFS's.
2330
If the transport is readonly or None, "." is opened automatically.
2333
if type(shape) not in (list, tuple):
2334
raise AssertionError("Parameter 'shape' should be "
2335
"a list or a tuple. Got %r instead" % (shape,))
2336
# It's OK to just create them using forward slashes on windows.
2337
if transport is None or transport.is_readonly():
2338
transport = get_transport(".")
2340
self.assertIsInstance(name, basestring)
2342
transport.mkdir(urlutils.escape(name[:-1]))
2344
if line_endings == 'binary':
2346
elif line_endings == 'native':
2349
raise errors.BzrError(
2350
'Invalid line ending request %r' % line_endings)
2351
content = "contents of %s%s" % (name.encode('utf-8'), end)
2352
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2354
def build_tree_contents(self, shape):
2355
build_tree_contents(shape)
2357
def assertInWorkingTree(self, path, root_path='.', tree=None):
2358
"""Assert whether path or paths are in the WorkingTree"""
2360
tree = workingtree.WorkingTree.open(root_path)
2361
if not isinstance(path, basestring):
2363
self.assertInWorkingTree(p, tree=tree)
2365
self.assertIsNot(tree.path2id(path), None,
2366
path+' not in working tree.')
2368
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2369
"""Assert whether path or paths are not in the WorkingTree"""
2371
tree = workingtree.WorkingTree.open(root_path)
2372
if not isinstance(path, basestring):
2374
self.assertNotInWorkingTree(p,tree=tree)
2376
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2379
class TestCaseWithTransport(TestCaseInTempDir):
2380
"""A test case that provides get_url and get_readonly_url facilities.
2382
These back onto two transport servers, one for readonly access and one for
2385
If no explicit class is provided for readonly access, a
2386
ReadonlyTransportDecorator is used instead which allows the use of non disk
2387
based read write transports.
2389
If an explicit class is provided for readonly access, that server and the
2390
readwrite one must both define get_url() as resolving to os.getcwd().
2393
def get_vfs_only_server(self):
2394
"""See TestCaseWithMemoryTransport.
2396
This is useful for some tests with specific servers that need
2399
if self.__vfs_server is None:
2400
self.__vfs_server = self.vfs_transport_factory()
2401
self.__vfs_server.setUp()
2402
self.addCleanup(self.__vfs_server.tearDown)
2403
return self.__vfs_server
2405
def make_branch_and_tree(self, relpath, format=None):
2406
"""Create a branch on the transport and a tree locally.
2408
If the transport is not a LocalTransport, the Tree can't be created on
2409
the transport. In that case if the vfs_transport_factory is
2410
LocalURLServer the working tree is created in the local
2411
directory backing the transport, and the returned tree's branch and
2412
repository will also be accessed locally. Otherwise a lightweight
2413
checkout is created and returned.
2415
:param format: The BzrDirFormat.
2416
:returns: the WorkingTree.
2418
# TODO: always use the local disk path for the working tree,
2419
# this obviously requires a format that supports branch references
2420
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2422
b = self.make_branch(relpath, format=format)
2424
return b.bzrdir.create_workingtree()
2425
except errors.NotLocalUrl:
2426
# We can only make working trees locally at the moment. If the
2427
# transport can't support them, then we keep the non-disk-backed
2428
# branch and create a local checkout.
2429
if self.vfs_transport_factory is LocalURLServer:
2430
# the branch is colocated on disk, we cannot create a checkout.
2431
# hopefully callers will expect this.
2432
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2433
wt = local_controldir.create_workingtree()
2434
if wt.branch._format != b._format:
2436
# Make sure that assigning to wt._branch fixes wt.branch,
2437
# in case the implementation details of workingtree objects
2439
self.assertIs(b, wt.branch)
2442
return b.create_checkout(relpath, lightweight=True)
2444
def assertIsDirectory(self, relpath, transport):
2445
"""Assert that relpath within transport is a directory.
2447
This may not be possible on all transports; in that case it propagates
2448
a TransportNotPossible.
2451
mode = transport.stat(relpath).st_mode
2452
except errors.NoSuchFile:
2453
self.fail("path %s is not a directory; no such file"
2455
if not stat.S_ISDIR(mode):
2456
self.fail("path %s is not a directory; has mode %#o"
2459
def assertTreesEqual(self, left, right):
2460
"""Check that left and right have the same content and properties."""
2461
# we use a tree delta to check for equality of the content, and we
2462
# manually check for equality of other things such as the parents list.
2463
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2464
differences = left.changes_from(right)
2465
self.assertFalse(differences.has_changed(),
2466
"Trees %r and %r are different: %r" % (left, right, differences))
2469
super(TestCaseWithTransport, self).setUp()
2470
self.__vfs_server = None
2473
class ChrootedTestCase(TestCaseWithTransport):
2474
"""A support class that provides readonly urls outside the local namespace.
2476
This is done by checking if self.transport_server is a MemoryServer. if it
2477
is then we are chrooted already, if it is not then an HttpServer is used
2480
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2481
be used without needed to redo it when a different
2482
subclass is in use ?
2486
super(ChrootedTestCase, self).setUp()
2487
if not self.vfs_transport_factory == MemoryServer:
2488
self.transport_readonly_server = HttpServer
2491
def condition_id_re(pattern):
2492
"""Create a condition filter which performs a re check on a test's id.
2494
:param pattern: A regular expression string.
2495
:return: A callable that returns True if the re matches.
2497
filter_re = osutils.re_compile_checked(pattern, 0,
2499
def condition(test):
2501
return filter_re.search(test_id)
2505
def condition_isinstance(klass_or_klass_list):
2506
"""Create a condition filter which returns isinstance(param, klass).
2508
:return: A callable which when called with one parameter obj return the
2509
result of isinstance(obj, klass_or_klass_list).
2512
return isinstance(obj, klass_or_klass_list)
2516
def condition_id_in_list(id_list):
2517
"""Create a condition filter which verify that test's id in a list.
2519
:param id_list: A TestIdList object.
2520
:return: A callable that returns True if the test's id appears in the list.
2522
def condition(test):
2523
return id_list.includes(test.id())
2527
def condition_id_startswith(starts):
2528
"""Create a condition filter verifying that test's id starts with a string.
2530
:param starts: A list of string.
2531
:return: A callable that returns True if the test's id starts with one of
2534
def condition(test):
2535
for start in starts:
2536
if test.id().startswith(start):
2542
def exclude_tests_by_condition(suite, condition):
2543
"""Create a test suite which excludes some tests from suite.
2545
:param suite: The suite to get tests from.
2546
:param condition: A callable whose result evaluates True when called with a
2547
test case which should be excluded from the result.
2548
:return: A suite which contains the tests found in suite that fail
2552
for test in iter_suite_tests(suite):
2553
if not condition(test):
2555
return TestUtil.TestSuite(result)
2558
def filter_suite_by_condition(suite, condition):
2559
"""Create a test suite by filtering another one.
2561
:param suite: The source suite.
2562
:param condition: A callable whose result evaluates True when called with a
2563
test case which should be included in the result.
2564
:return: A suite which contains the tests found in suite that pass
2568
for test in iter_suite_tests(suite):
2571
return TestUtil.TestSuite(result)
2574
def filter_suite_by_re(suite, pattern):
2575
"""Create a test suite by filtering another one.
2577
:param suite: the source suite
2578
:param pattern: pattern that names must match
2579
:returns: the newly created suite
2581
condition = condition_id_re(pattern)
2582
result_suite = filter_suite_by_condition(suite, condition)
2586
def filter_suite_by_id_list(suite, test_id_list):
2587
"""Create a test suite by filtering another one.
2589
:param suite: The source suite.
2590
:param test_id_list: A list of the test ids to keep as strings.
2591
:returns: the newly created suite
2593
condition = condition_id_in_list(test_id_list)
2594
result_suite = filter_suite_by_condition(suite, condition)
2598
def filter_suite_by_id_startswith(suite, start):
2599
"""Create a test suite by filtering another one.
2601
:param suite: The source suite.
2602
:param start: A list of string the test id must start with one of.
2603
:returns: the newly created suite
2605
condition = condition_id_startswith(start)
2606
result_suite = filter_suite_by_condition(suite, condition)
2610
def exclude_tests_by_re(suite, pattern):
2611
"""Create a test suite which excludes some tests from suite.
2613
:param suite: The suite to get tests from.
2614
:param pattern: A regular expression string. Test ids that match this
2615
pattern will be excluded from the result.
2616
:return: A TestSuite that contains all the tests from suite without the
2617
tests that matched pattern. The order of tests is the same as it was in
2620
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2623
def preserve_input(something):
2624
"""A helper for performing test suite transformation chains.
2626
:param something: Anything you want to preserve.
2632
def randomize_suite(suite):
2633
"""Return a new TestSuite with suite's tests in random order.
2635
The tests in the input suite are flattened into a single suite in order to
2636
accomplish this. Any nested TestSuites are removed to provide global
2639
tests = list(iter_suite_tests(suite))
2640
random.shuffle(tests)
2641
return TestUtil.TestSuite(tests)
2644
def split_suite_by_condition(suite, condition):
2645
"""Split a test suite into two by a condition.
2647
:param suite: The suite to split.
2648
:param condition: The condition to match on. Tests that match this
2649
condition are returned in the first test suite, ones that do not match
2650
are in the second suite.
2651
:return: A tuple of two test suites, where the first contains tests from
2652
suite matching the condition, and the second contains the remainder
2653
from suite. The order within each output suite is the same as it was in
2658
for test in iter_suite_tests(suite):
2660
matched.append(test)
2662
did_not_match.append(test)
2663
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2666
def split_suite_by_re(suite, pattern):
2667
"""Split a test suite into two by a regular expression.
2669
:param suite: The suite to split.
2670
:param pattern: A regular expression string. Test ids that match this
2671
pattern will be in the first test suite returned, and the others in the
2672
second test suite returned.
2673
:return: A tuple of two test suites, where the first contains tests from
2674
suite matching pattern, and the second contains the remainder from
2675
suite. The order within each output suite is the same as it was in
2678
return split_suite_by_condition(suite, condition_id_re(pattern))
2681
def run_suite(suite, name='test', verbose=False, pattern=".*",
2682
stop_on_failure=False,
2683
transport=None, lsprof_timed=None, bench_history=None,
2684
matching_tests_first=None,
2687
exclude_pattern=None,
2690
suite_decorators=None,
2692
"""Run a test suite for bzr selftest.
2694
:param runner_class: The class of runner to use. Must support the
2695
constructor arguments passed by run_suite which are more than standard
2697
:return: A boolean indicating success.
2699
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2704
if runner_class is None:
2705
runner_class = TextTestRunner
2708
runner = runner_class(stream=stream,
2710
verbosity=verbosity,
2711
bench_history=bench_history,
2712
list_only=list_only,
2715
runner.stop_on_failure=stop_on_failure
2716
# built in decorator factories:
2718
random_order(random_seed, runner),
2719
exclude_tests(exclude_pattern),
2721
if matching_tests_first:
2722
decorators.append(tests_first(pattern))
2724
decorators.append(filter_tests(pattern))
2725
if suite_decorators:
2726
decorators.extend(suite_decorators)
2727
for decorator in decorators:
2728
suite = decorator(suite)
2729
result = runner.run(suite)
2734
return result.wasStrictlySuccessful()
2736
return result.wasSuccessful()
2739
# A registry where get() returns a suite decorator.
2740
parallel_registry = registry.Registry()
2743
def fork_decorator(suite):
2744
concurrency = local_concurrency()
2745
if concurrency == 1:
2747
from testtools import ConcurrentTestSuite
2748
return ConcurrentTestSuite(suite, fork_for_tests)
2749
parallel_registry.register('fork', fork_decorator)
2752
def subprocess_decorator(suite):
2753
concurrency = local_concurrency()
2754
if concurrency == 1:
2756
from testtools import ConcurrentTestSuite
2757
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2758
parallel_registry.register('subprocess', subprocess_decorator)
2761
def exclude_tests(exclude_pattern):
2762
"""Return a test suite decorator that excludes tests."""
2763
if exclude_pattern is None:
2764
return identity_decorator
2765
def decorator(suite):
2766
return ExcludeDecorator(suite, exclude_pattern)
2770
def filter_tests(pattern):
2772
return identity_decorator
2773
def decorator(suite):
2774
return FilterTestsDecorator(suite, pattern)
2778
def random_order(random_seed, runner):
2779
"""Return a test suite decorator factory for randomising tests order.
2781
:param random_seed: now, a string which casts to a long, or a long.
2782
:param runner: A test runner with a stream attribute to report on.
2784
if random_seed is None:
2785
return identity_decorator
2786
def decorator(suite):
2787
return RandomDecorator(suite, random_seed, runner.stream)
2791
def tests_first(pattern):
2793
return identity_decorator
2794
def decorator(suite):
2795
return TestFirstDecorator(suite, pattern)
2799
def identity_decorator(suite):
2804
class TestDecorator(TestSuite):
2805
"""A decorator for TestCase/TestSuite objects.
2807
Usually, subclasses should override __iter__(used when flattening test
2808
suites), which we do to filter, reorder, parallelise and so on, run() and
2812
def __init__(self, suite):
2813
TestSuite.__init__(self)
2816
def countTestCases(self):
2819
cases += test.countTestCases()
2826
def run(self, result):
2827
# Use iteration on self, not self._tests, to allow subclasses to hook
2830
if result.shouldStop:
2836
class ExcludeDecorator(TestDecorator):
2837
"""A decorator which excludes test matching an exclude pattern."""
2839
def __init__(self, suite, exclude_pattern):
2840
TestDecorator.__init__(self, suite)
2841
self.exclude_pattern = exclude_pattern
2842
self.excluded = False
2846
return iter(self._tests)
2847
self.excluded = True
2848
suite = exclude_tests_by_re(self, self.exclude_pattern)
2850
self.addTests(suite)
2851
return iter(self._tests)
2854
class FilterTestsDecorator(TestDecorator):
2855
"""A decorator which filters tests to those matching a pattern."""
2857
def __init__(self, suite, pattern):
2858
TestDecorator.__init__(self, suite)
2859
self.pattern = pattern
2860
self.filtered = False
2864
return iter(self._tests)
2865
self.filtered = True
2866
suite = filter_suite_by_re(self, self.pattern)
2868
self.addTests(suite)
2869
return iter(self._tests)
2872
class RandomDecorator(TestDecorator):
2873
"""A decorator which randomises the order of its tests."""
2875
def __init__(self, suite, random_seed, stream):
2876
TestDecorator.__init__(self, suite)
2877
self.random_seed = random_seed
2878
self.randomised = False
2879
self.stream = stream
2883
return iter(self._tests)
2884
self.randomised = True
2885
self.stream.writeln("Randomizing test order using seed %s\n" %
2886
(self.actual_seed()))
2887
# Initialise the random number generator.
2888
random.seed(self.actual_seed())
2889
suite = randomize_suite(self)
2891
self.addTests(suite)
2892
return iter(self._tests)
2894
def actual_seed(self):
2895
if self.random_seed == "now":
2896
# We convert the seed to a long to make it reuseable across
2897
# invocations (because the user can reenter it).
2898
self.random_seed = long(time.time())
2900
# Convert the seed to a long if we can
2902
self.random_seed = long(self.random_seed)
2905
return self.random_seed
2908
class TestFirstDecorator(TestDecorator):
2909
"""A decorator which moves named tests to the front."""
2911
def __init__(self, suite, pattern):
2912
TestDecorator.__init__(self, suite)
2913
self.pattern = pattern
2914
self.filtered = False
2918
return iter(self._tests)
2919
self.filtered = True
2920
suites = split_suite_by_re(self, self.pattern)
2922
self.addTests(suites)
2923
return iter(self._tests)
2926
def partition_tests(suite, count):
2927
"""Partition suite into count lists of tests."""
2929
tests = list(iter_suite_tests(suite))
2930
tests_per_process = int(math.ceil(float(len(tests)) / count))
2931
for block in range(count):
2932
low_test = block * tests_per_process
2933
high_test = low_test + tests_per_process
2934
process_tests = tests[low_test:high_test]
2935
result.append(process_tests)
2939
def fork_for_tests(suite):
2940
"""Take suite and start up one runner per CPU by forking()
2942
:return: An iterable of TestCase-like objects which can each have
2943
run(result) called on them to feed tests to result.
2945
concurrency = local_concurrency()
2947
from subunit import TestProtocolClient, ProtocolTestCase
2948
class TestInOtherProcess(ProtocolTestCase):
2949
# Should be in subunit, I think. RBC.
2950
def __init__(self, stream, pid):
2951
ProtocolTestCase.__init__(self, stream)
2954
def run(self, result):
2956
ProtocolTestCase.run(self, result)
2958
os.waitpid(self.pid, os.WNOHANG)
2960
test_blocks = partition_tests(suite, concurrency)
2961
for process_tests in test_blocks:
2962
process_suite = TestSuite()
2963
process_suite.addTests(process_tests)
2964
c2pread, c2pwrite = os.pipe()
2969
# Leave stderr and stdout open so we can see test noise
2970
# Close stdin so that the child goes away if it decides to
2971
# read from stdin (otherwise its a roulette to see what
2972
# child actually gets keystrokes for pdb etc).
2975
stream = os.fdopen(c2pwrite, 'wb', 1)
2976
subunit_result = TestProtocolClient(stream)
2977
process_suite.run(subunit_result)
2982
stream = os.fdopen(c2pread, 'rb', 1)
2983
test = TestInOtherProcess(stream, pid)
2988
def reinvoke_for_tests(suite):
2989
"""Take suite and start up one runner per CPU using subprocess().
2991
:return: An iterable of TestCase-like objects which can each have
2992
run(result) called on them to feed tests to result.
2994
concurrency = local_concurrency()
2996
from subunit import TestProtocolClient, ProtocolTestCase
2997
class TestInSubprocess(ProtocolTestCase):
2998
def __init__(self, process, name):
2999
ProtocolTestCase.__init__(self, process.stdout)
3000
self.process = process
3001
self.process.stdin.close()
3004
def run(self, result):
3006
ProtocolTestCase.run(self, result)
3009
os.unlink(self.name)
3010
# print "pid %d finished" % finished_process
3011
test_blocks = partition_tests(suite, concurrency)
3012
for process_tests in test_blocks:
3013
# ugly; currently reimplement rather than reuses TestCase methods.
3014
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3015
if not os.path.isfile(bzr_path):
3016
# We are probably installed. Assume sys.argv is the right file
3017
bzr_path = sys.argv[0]
3018
fd, test_list_file_name = tempfile.mkstemp()
3019
test_list_file = os.fdopen(fd, 'wb', 1)
3020
for test in process_tests:
3021
test_list_file.write(test.id() + '\n')
3022
test_list_file.close()
3024
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3026
if '--no-plugins' in sys.argv:
3027
argv.append('--no-plugins')
3028
# stderr=STDOUT would be ideal, but until we prevent noise on
3029
# stderr it can interrupt the subunit protocol.
3030
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3032
test = TestInSubprocess(process, test_list_file_name)
3035
os.unlink(test_list_file_name)
3040
def cpucount(content):
3041
lines = content.splitlines()
3042
prefix = 'processor'
3044
if line.startswith(prefix):
3045
concurrency = int(line[line.find(':')+1:]) + 1
3049
def local_concurrency():
3051
content = file('/proc/cpuinfo', 'rb').read()
3052
concurrency = cpucount(content)
3053
except Exception, e:
3058
class BZRTransformingResult(unittest.TestResult):
3060
def __init__(self, target):
3061
unittest.TestResult.__init__(self)
3062
self.result = target
3064
def startTest(self, test):
3065
self.result.startTest(test)
3067
def stopTest(self, test):
3068
self.result.stopTest(test)
3070
def addError(self, test, err):
3071
feature = self._error_looks_like('UnavailableFeature: ', err)
3072
if feature is not None:
3073
self.result.addNotSupported(test, feature)
3075
self.result.addError(test, err)
3077
def addFailure(self, test, err):
3078
known = self._error_looks_like('KnownFailure: ', err)
3079
if known is not None:
3080
self.result._addKnownFailure(test, [KnownFailure,
3081
KnownFailure(known), None])
3083
self.result.addFailure(test, err)
3085
def addSkip(self, test, reason):
3086
self.result.addSkip(test, reason)
3088
def addSuccess(self, test):
3089
self.result.addSuccess(test)
3091
def _error_looks_like(self, prefix, err):
3092
"""Deserialize exception and returns the stringify value."""
3096
if isinstance(exc, subunit.RemoteException):
3097
# stringify the exception gives access to the remote traceback
3098
# We search the last line for 'prefix'
3099
lines = str(exc).split('\n')
3100
while lines and not lines[-1]:
3103
if lines[-1].startswith(prefix):
3104
value = lines[-1][len(prefix):]
3108
# Controlled by "bzr selftest -E=..." option
3109
selftest_debug_flags = set()
3112
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3114
test_suite_factory=None,
3117
matching_tests_first=None,
3120
exclude_pattern=None,
3126
suite_decorators=None,
3128
"""Run the whole test suite under the enhanced runner"""
3129
# XXX: Very ugly way to do this...
3130
# Disable warning about old formats because we don't want it to disturb
3131
# any blackbox tests.
3132
from bzrlib import repository
3133
repository._deprecation_warning_done = True
3135
global default_transport
3136
if transport is None:
3137
transport = default_transport
3138
old_transport = default_transport
3139
default_transport = transport
3140
global selftest_debug_flags
3141
old_debug_flags = selftest_debug_flags
3142
if debug_flags is not None:
3143
selftest_debug_flags = set(debug_flags)
3145
if load_list is None:
3148
keep_only = load_test_id_list(load_list)
3149
if test_suite_factory is None:
3150
suite = test_suite(keep_only, starting_with)
3152
suite = test_suite_factory()
3153
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3154
stop_on_failure=stop_on_failure,
3155
transport=transport,
3156
lsprof_timed=lsprof_timed,
3157
bench_history=bench_history,
3158
matching_tests_first=matching_tests_first,
3159
list_only=list_only,
3160
random_seed=random_seed,
3161
exclude_pattern=exclude_pattern,
3163
runner_class=runner_class,
3164
suite_decorators=suite_decorators,
3167
default_transport = old_transport
3168
selftest_debug_flags = old_debug_flags
3171
def load_test_id_list(file_name):
3172
"""Load a test id list from a text file.
3174
The format is one test id by line. No special care is taken to impose
3175
strict rules, these test ids are used to filter the test suite so a test id
3176
that do not match an existing test will do no harm. This allows user to add
3177
comments, leave blank lines, etc.
3181
ftest = open(file_name, 'rt')
3183
if e.errno != errno.ENOENT:
3186
raise errors.NoSuchFile(file_name)
3188
for test_name in ftest.readlines():
3189
test_list.append(test_name.strip())
3194
def suite_matches_id_list(test_suite, id_list):
3195
"""Warns about tests not appearing or appearing more than once.
3197
:param test_suite: A TestSuite object.
3198
:param test_id_list: The list of test ids that should be found in
3201
:return: (absents, duplicates) absents is a list containing the test found
3202
in id_list but not in test_suite, duplicates is a list containing the
3203
test found multiple times in test_suite.
3205
When using a prefined test id list, it may occurs that some tests do not
3206
exist anymore or that some tests use the same id. This function warns the
3207
tester about potential problems in his workflow (test lists are volatile)
3208
or in the test suite itself (using the same id for several tests does not
3209
help to localize defects).
3211
# Build a dict counting id occurrences
3213
for test in iter_suite_tests(test_suite):
3215
tests[id] = tests.get(id, 0) + 1
3220
occurs = tests.get(id, 0)
3222
not_found.append(id)
3224
duplicates.append(id)
3226
return not_found, duplicates
3229
class TestIdList(object):
3230
"""Test id list to filter a test suite.
3232
Relying on the assumption that test ids are built as:
3233
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3234
notation, this class offers methods to :
3235
- avoid building a test suite for modules not refered to in the test list,
3236
- keep only the tests listed from the module test suite.
3239
def __init__(self, test_id_list):
3240
# When a test suite needs to be filtered against us we compare test ids
3241
# for equality, so a simple dict offers a quick and simple solution.
3242
self.tests = dict().fromkeys(test_id_list, True)
3244
# While unittest.TestCase have ids like:
3245
# <module>.<class>.<method>[(<param+)],
3246
# doctest.DocTestCase can have ids like:
3249
# <module>.<function>
3250
# <module>.<class>.<method>
3252
# Since we can't predict a test class from its name only, we settle on
3253
# a simple constraint: a test id always begins with its module name.
3256
for test_id in test_id_list:
3257
parts = test_id.split('.')
3258
mod_name = parts.pop(0)
3259
modules[mod_name] = True
3261
mod_name += '.' + part
3262
modules[mod_name] = True
3263
self.modules = modules
3265
def refers_to(self, module_name):
3266
"""Is there tests for the module or one of its sub modules."""
3267
return self.modules.has_key(module_name)
3269
def includes(self, test_id):
3270
return self.tests.has_key(test_id)
3273
class TestPrefixAliasRegistry(registry.Registry):
3274
"""A registry for test prefix aliases.
3276
This helps implement shorcuts for the --starting-with selftest
3277
option. Overriding existing prefixes is not allowed but not fatal (a
3278
warning will be emitted).
3281
def register(self, key, obj, help=None, info=None,
3282
override_existing=False):
3283
"""See Registry.register.
3285
Trying to override an existing alias causes a warning to be emitted,
3286
not a fatal execption.
3289
super(TestPrefixAliasRegistry, self).register(
3290
key, obj, help=help, info=info, override_existing=False)
3292
actual = self.get(key)
3293
note('Test prefix alias %s is already used for %s, ignoring %s'
3294
% (key, actual, obj))
3296
def resolve_alias(self, id_start):
3297
"""Replace the alias by the prefix in the given string.
3299
Using an unknown prefix is an error to help catching typos.
3301
parts = id_start.split('.')
3303
parts[0] = self.get(parts[0])
3305
raise errors.BzrCommandError(
3306
'%s is not a known test prefix alias' % parts[0])
3307
return '.'.join(parts)
3310
test_prefix_alias_registry = TestPrefixAliasRegistry()
3311
"""Registry of test prefix aliases."""
3314
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3315
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3316
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3318
# Obvious higest levels prefixes, feel free to add your own via a plugin
3319
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3320
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3321
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3322
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3323
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3326
def test_suite(keep_only=None, starting_with=None):
3327
"""Build and return TestSuite for the whole of bzrlib.
3329
:param keep_only: A list of test ids limiting the suite returned.
3331
:param starting_with: An id limiting the suite returned to the tests
3334
This function can be replaced if you need to change the default test
3335
suite on a global basis, but it is not encouraged.
3339
'bzrlib.tests.blackbox',
3340
'bzrlib.tests.branch_implementations',
3341
'bzrlib.tests.bzrdir_implementations',
3342
'bzrlib.tests.commands',
3343
'bzrlib.tests.interrepository_implementations',
3344
'bzrlib.tests.intertree_implementations',
3345
'bzrlib.tests.inventory_implementations',
3346
'bzrlib.tests.per_interbranch',
3347
'bzrlib.tests.per_lock',
3348
'bzrlib.tests.per_repository',
3349
'bzrlib.tests.per_repository_chk',
3350
'bzrlib.tests.per_repository_reference',
3351
'bzrlib.tests.test__chk_map',
3352
'bzrlib.tests.test__dirstate_helpers',
3353
'bzrlib.tests.test__groupcompress',
3354
'bzrlib.tests.test__walkdirs_win32',
3355
'bzrlib.tests.test_ancestry',
3356
'bzrlib.tests.test_annotate',
3357
'bzrlib.tests.test_api',
3358
'bzrlib.tests.test_atomicfile',
3359
'bzrlib.tests.test_bad_files',
3360
'bzrlib.tests.test_bisect_multi',
3361
'bzrlib.tests.test_branch',
3362
'bzrlib.tests.test_branchbuilder',
3363
'bzrlib.tests.test_btree_index',
3364
'bzrlib.tests.test_bugtracker',
3365
'bzrlib.tests.test_bundle',
3366
'bzrlib.tests.test_bzrdir',
3367
'bzrlib.tests.test__chunks_to_lines',
3368
'bzrlib.tests.test_cache_utf8',
3369
'bzrlib.tests.test_chk_map',
3370
'bzrlib.tests.test_chunk_writer',
3371
'bzrlib.tests.test_clean_tree',
3372
'bzrlib.tests.test_commands',
3373
'bzrlib.tests.test_commit',
3374
'bzrlib.tests.test_commit_merge',
3375
'bzrlib.tests.test_config',
3376
'bzrlib.tests.test_conflicts',
3377
'bzrlib.tests.test_counted_lock',
3378
'bzrlib.tests.test_decorators',
3379
'bzrlib.tests.test_delta',
3380
'bzrlib.tests.test_debug',
3381
'bzrlib.tests.test_deprecated_graph',
3382
'bzrlib.tests.test_diff',
3383
'bzrlib.tests.test_directory_service',
3384
'bzrlib.tests.test_dirstate',
3385
'bzrlib.tests.test_email_message',
3386
'bzrlib.tests.test_eol_filters',
3387
'bzrlib.tests.test_errors',
3388
'bzrlib.tests.test_export',
3389
'bzrlib.tests.test_extract',
3390
'bzrlib.tests.test_fetch',
3391
'bzrlib.tests.test_fifo_cache',
3392
'bzrlib.tests.test_filters',
3393
'bzrlib.tests.test_ftp_transport',
3394
'bzrlib.tests.test_foreign',
3395
'bzrlib.tests.test_generate_docs',
3396
'bzrlib.tests.test_generate_ids',
3397
'bzrlib.tests.test_globbing',
3398
'bzrlib.tests.test_gpg',
3399
'bzrlib.tests.test_graph',
3400
'bzrlib.tests.test_groupcompress',
3401
'bzrlib.tests.test_hashcache',
3402
'bzrlib.tests.test_help',
3403
'bzrlib.tests.test_hooks',
3404
'bzrlib.tests.test_http',
3405
'bzrlib.tests.test_http_implementations',
3406
'bzrlib.tests.test_http_response',
3407
'bzrlib.tests.test_https_ca_bundle',
3408
'bzrlib.tests.test_identitymap',
3409
'bzrlib.tests.test_ignores',
3410
'bzrlib.tests.test_index',
3411
'bzrlib.tests.test_info',
3412
'bzrlib.tests.test_inv',
3413
'bzrlib.tests.test_inventory_delta',
3414
'bzrlib.tests.test_knit',
3415
'bzrlib.tests.test_lazy_import',
3416
'bzrlib.tests.test_lazy_regex',
3417
'bzrlib.tests.test_lockable_files',
3418
'bzrlib.tests.test_lockdir',
3419
'bzrlib.tests.test_log',
3420
'bzrlib.tests.test_lru_cache',
3421
'bzrlib.tests.test_lsprof',
3422
'bzrlib.tests.test_mail_client',
3423
'bzrlib.tests.test_memorytree',
3424
'bzrlib.tests.test_merge',
3425
'bzrlib.tests.test_merge3',
3426
'bzrlib.tests.test_merge_core',
3427
'bzrlib.tests.test_merge_directive',
3428
'bzrlib.tests.test_missing',
3429
'bzrlib.tests.test_msgeditor',
3430
'bzrlib.tests.test_multiparent',
3431
'bzrlib.tests.test_mutabletree',
3432
'bzrlib.tests.test_nonascii',
3433
'bzrlib.tests.test_options',
3434
'bzrlib.tests.test_osutils',
3435
'bzrlib.tests.test_osutils_encodings',
3436
'bzrlib.tests.test_pack',
3437
'bzrlib.tests.test_pack_repository',
3438
'bzrlib.tests.test_patch',
3439
'bzrlib.tests.test_patches',
3440
'bzrlib.tests.test_permissions',
3441
'bzrlib.tests.test_plugins',
3442
'bzrlib.tests.test_progress',
3443
'bzrlib.tests.test_read_bundle',
3444
'bzrlib.tests.test_reconcile',
3445
'bzrlib.tests.test_reconfigure',
3446
'bzrlib.tests.test_registry',
3447
'bzrlib.tests.test_remote',
3448
'bzrlib.tests.test_rename_map',
3449
'bzrlib.tests.test_repository',
3450
'bzrlib.tests.test_revert',
3451
'bzrlib.tests.test_revision',
3452
'bzrlib.tests.test_revisionspec',
3453
'bzrlib.tests.test_revisiontree',
3454
'bzrlib.tests.test_rio',
3455
'bzrlib.tests.test_rules',
3456
'bzrlib.tests.test_sampler',
3457
'bzrlib.tests.test_selftest',
3458
'bzrlib.tests.test_serializer',
3459
'bzrlib.tests.test_setup',
3460
'bzrlib.tests.test_sftp_transport',
3461
'bzrlib.tests.test_shelf',
3462
'bzrlib.tests.test_shelf_ui',
3463
'bzrlib.tests.test_smart',
3464
'bzrlib.tests.test_smart_add',
3465
'bzrlib.tests.test_smart_request',
3466
'bzrlib.tests.test_smart_transport',
3467
'bzrlib.tests.test_smtp_connection',
3468
'bzrlib.tests.test_source',
3469
'bzrlib.tests.test_ssh_transport',
3470
'bzrlib.tests.test_status',
3471
'bzrlib.tests.test_store',
3472
'bzrlib.tests.test_strace',
3473
'bzrlib.tests.test_subsume',
3474
'bzrlib.tests.test_switch',
3475
'bzrlib.tests.test_symbol_versioning',
3476
'bzrlib.tests.test_tag',
3477
'bzrlib.tests.test_testament',
3478
'bzrlib.tests.test_textfile',
3479
'bzrlib.tests.test_textmerge',
3480
'bzrlib.tests.test_timestamp',
3481
'bzrlib.tests.test_trace',
3482
'bzrlib.tests.test_transactions',
3483
'bzrlib.tests.test_transform',
3484
'bzrlib.tests.test_transport',
3485
'bzrlib.tests.test_transport_implementations',
3486
'bzrlib.tests.test_transport_log',
3487
'bzrlib.tests.test_tree',
3488
'bzrlib.tests.test_treebuilder',
3489
'bzrlib.tests.test_tsort',
3490
'bzrlib.tests.test_tuned_gzip',
3491
'bzrlib.tests.test_ui',
3492
'bzrlib.tests.test_uncommit',
3493
'bzrlib.tests.test_upgrade',
3494
'bzrlib.tests.test_upgrade_stacked',
3495
'bzrlib.tests.test_urlutils',
3496
'bzrlib.tests.test_version',
3497
'bzrlib.tests.test_version_info',
3498
'bzrlib.tests.test_versionedfile',
3499
'bzrlib.tests.test_weave',
3500
'bzrlib.tests.test_whitebox',
3501
'bzrlib.tests.test_win32utils',
3502
'bzrlib.tests.test_workingtree',
3503
'bzrlib.tests.test_workingtree_4',
3504
'bzrlib.tests.test_wsgi',
3505
'bzrlib.tests.test_xml',
3506
'bzrlib.tests.tree_implementations',
3507
'bzrlib.tests.workingtree_implementations',
3508
'bzrlib.util.tests.test_bencode',
3511
loader = TestUtil.TestLoader()
3514
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3515
for start in starting_with]
3516
# We take precedence over keep_only because *at loading time* using
3517
# both options means we will load less tests for the same final result.
3518
def interesting_module(name):
3519
for start in starting_with:
3521
# Either the module name starts with the specified string
3522
name.startswith(start)
3523
# or it may contain tests starting with the specified string
3524
or start.startswith(name)
3528
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3530
elif keep_only is not None:
3531
id_filter = TestIdList(keep_only)
3532
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3533
def interesting_module(name):
3534
return id_filter.refers_to(name)
3537
loader = TestUtil.TestLoader()
3538
def interesting_module(name):
3539
# No filtering, all modules are interesting
3542
suite = loader.suiteClass()
3544
# modules building their suite with loadTestsFromModuleNames
3545
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3547
modules_to_doctest = [
3549
'bzrlib.branchbuilder',
3552
'bzrlib.iterablefile',
3556
'bzrlib.symbol_versioning',
3559
'bzrlib.version_info_formats.format_custom',
3562
for mod in modules_to_doctest:
3563
if not interesting_module(mod):
3564
# No tests to keep here, move along
3567
# note that this really does mean "report only" -- doctest
3568
# still runs the rest of the examples
3569
doc_suite = doctest.DocTestSuite(mod,
3570
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3571
except ValueError, e:
3572
print '**failed to get doctest for: %s\n%s' % (mod, e)
3574
if len(doc_suite._tests) == 0:
3575
raise errors.BzrError("no doctests found in %s" % (mod,))
3576
suite.addTest(doc_suite)
3578
default_encoding = sys.getdefaultencoding()
3579
for name, plugin in bzrlib.plugin.plugins().items():
3580
if not interesting_module(plugin.module.__name__):
3582
plugin_suite = plugin.test_suite()
3583
# We used to catch ImportError here and turn it into just a warning,
3584
# but really if you don't have --no-plugins this should be a failure.
3585
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3586
if plugin_suite is None:
3587
plugin_suite = plugin.load_plugin_tests(loader)
3588
if plugin_suite is not None:
3589
suite.addTest(plugin_suite)
3590
if default_encoding != sys.getdefaultencoding():
3591
bzrlib.trace.warning(
3592
'Plugin "%s" tried to reset default encoding to: %s', name,
3593
sys.getdefaultencoding())
3595
sys.setdefaultencoding(default_encoding)
3598
suite = filter_suite_by_id_startswith(suite, starting_with)
3600
if keep_only is not None:
3601
# Now that the referred modules have loaded their tests, keep only the
3603
suite = filter_suite_by_id_list(suite, id_filter)
3604
# Do some sanity checks on the id_list filtering
3605
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3607
# The tester has used both keep_only and starting_with, so he is
3608
# already aware that some tests are excluded from the list, there
3609
# is no need to tell him which.
3612
# Some tests mentioned in the list are not in the test suite. The
3613
# list may be out of date, report to the tester.
3614
for id in not_found:
3615
bzrlib.trace.warning('"%s" not found in the test suite', id)
3616
for id in duplicates:
3617
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3622
def multiply_scenarios(scenarios_left, scenarios_right):
3623
"""Multiply two sets of scenarios.
3625
:returns: the cartesian product of the two sets of scenarios, that is
3626
a scenario for every possible combination of a left scenario and a
3630
('%s,%s' % (left_name, right_name),
3631
dict(left_dict.items() + right_dict.items()))
3632
for left_name, left_dict in scenarios_left
3633
for right_name, right_dict in scenarios_right]
3636
def multiply_tests(tests, scenarios, result):
3637
"""Multiply tests_list by scenarios into result.
3639
This is the core workhorse for test parameterisation.
3641
Typically the load_tests() method for a per-implementation test suite will
3642
call multiply_tests and return the result.
3644
:param tests: The tests to parameterise.
3645
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3646
scenario_param_dict).
3647
:param result: A TestSuite to add created tests to.
3649
This returns the passed in result TestSuite with the cross product of all
3650
the tests repeated once for each scenario. Each test is adapted by adding
3651
the scenario name at the end of its id(), and updating the test object's
3652
__dict__ with the scenario_param_dict.
3654
>>> import bzrlib.tests.test_sampler
3655
>>> r = multiply_tests(
3656
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3657
... [('one', dict(param=1)),
3658
... ('two', dict(param=2))],
3660
>>> tests = list(iter_suite_tests(r))
3664
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3670
for test in iter_suite_tests(tests):
3671
apply_scenarios(test, scenarios, result)
3675
def apply_scenarios(test, scenarios, result):
3676
"""Apply the scenarios in scenarios to test and add to result.
3678
:param test: The test to apply scenarios to.
3679
:param scenarios: An iterable of scenarios to apply to test.
3681
:seealso: apply_scenario
3683
for scenario in scenarios:
3684
result.addTest(apply_scenario(test, scenario))
3688
def apply_scenario(test, scenario):
3689
"""Copy test and apply scenario to it.
3691
:param test: A test to adapt.
3692
:param scenario: A tuple describing the scenarion.
3693
The first element of the tuple is the new test id.
3694
The second element is a dict containing attributes to set on the
3696
:return: The adapted test.
3698
new_id = "%s(%s)" % (test.id(), scenario[0])
3699
new_test = clone_test(test, new_id)
3700
for name, value in scenario[1].items():
3701
setattr(new_test, name, value)
3705
def clone_test(test, new_id):
3706
"""Clone a test giving it a new id.
3708
:param test: The test to clone.
3709
:param new_id: The id to assign to it.
3710
:return: The new test.
3712
from copy import deepcopy
3713
new_test = deepcopy(test)
3714
new_test.id = lambda: new_id
3718
def _rmtree_temp_dir(dirname):
3719
# If LANG=C we probably have created some bogus paths
3720
# which rmtree(unicode) will fail to delete
3721
# so make sure we are using rmtree(str) to delete everything
3722
# except on win32, where rmtree(str) will fail
3723
# since it doesn't have the property of byte-stream paths
3724
# (they are either ascii or mbcs)
3725
if sys.platform == 'win32':
3726
# make sure we are using the unicode win32 api
3727
dirname = unicode(dirname)
3729
dirname = dirname.encode(sys.getfilesystemencoding())
3731
osutils.rmtree(dirname)
3733
if sys.platform == 'win32' and e.errno == errno.EACCES:
3734
sys.stderr.write('Permission denied: '
3735
'unable to remove testing dir '
3737
% (os.path.basename(dirname), e))
3742
class Feature(object):
3743
"""An operating system Feature."""
3746
self._available = None
3748
def available(self):
3749
"""Is the feature available?
3751
:return: True if the feature is available.
3753
if self._available is None:
3754
self._available = self._probe()
3755
return self._available
3758
"""Implement this method in concrete features.
3760
:return: True if the feature is available.
3762
raise NotImplementedError
3765
if getattr(self, 'feature_name', None):
3766
return self.feature_name()
3767
return self.__class__.__name__
3770
class _SymlinkFeature(Feature):
3773
return osutils.has_symlinks()
3775
def feature_name(self):
3778
SymlinkFeature = _SymlinkFeature()
3781
class _HardlinkFeature(Feature):
3784
return osutils.has_hardlinks()
3786
def feature_name(self):
3789
HardlinkFeature = _HardlinkFeature()
3792
class _OsFifoFeature(Feature):
3795
return getattr(os, 'mkfifo', None)
3797
def feature_name(self):
3798
return 'filesystem fifos'
3800
OsFifoFeature = _OsFifoFeature()
3803
class _UnicodeFilenameFeature(Feature):
3804
"""Does the filesystem support Unicode filenames?"""
3808
# Check for character combinations unlikely to be covered by any
3809
# single non-unicode encoding. We use the characters
3810
# - greek small letter alpha (U+03B1) and
3811
# - braille pattern dots-123456 (U+283F).
3812
os.stat(u'\u03b1\u283f')
3813
except UnicodeEncodeError:
3815
except (IOError, OSError):
3816
# The filesystem allows the Unicode filename but the file doesn't
3820
# The filesystem allows the Unicode filename and the file exists,
3824
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3827
def probe_unicode_in_user_encoding():
3828
"""Try to encode several unicode strings to use in unicode-aware tests.
3829
Return first successfull match.
3831
:return: (unicode value, encoded plain string value) or (None, None)
3833
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3834
for uni_val in possible_vals:
3836
str_val = uni_val.encode(osutils.get_user_encoding())
3837
except UnicodeEncodeError:
3838
# Try a different character
3841
return uni_val, str_val
3845
def probe_bad_non_ascii(encoding):
3846
"""Try to find [bad] character with code [128..255]
3847
that cannot be decoded to unicode in some encoding.
3848
Return None if all non-ascii characters is valid
3851
for i in xrange(128, 256):
3854
char.decode(encoding)
3855
except UnicodeDecodeError:
3860
class _HTTPSServerFeature(Feature):
3861
"""Some tests want an https Server, check if one is available.
3863
Right now, the only way this is available is under python2.6 which provides
3874
def feature_name(self):
3875
return 'HTTPSServer'
3878
HTTPSServerFeature = _HTTPSServerFeature()
3881
class _UnicodeFilename(Feature):
3882
"""Does the filesystem support Unicode filenames?"""
3887
except UnicodeEncodeError:
3889
except (IOError, OSError):
3890
# The filesystem allows the Unicode filename but the file doesn't
3894
# The filesystem allows the Unicode filename and the file exists,
3898
UnicodeFilename = _UnicodeFilename()
3901
class _UTF8Filesystem(Feature):
3902
"""Is the filesystem UTF-8?"""
3905
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3909
UTF8Filesystem = _UTF8Filesystem()
3912
class _CaseInsCasePresFilenameFeature(Feature):
3913
"""Is the file-system case insensitive, but case-preserving?"""
3916
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3918
# first check truly case-preserving for created files, then check
3919
# case insensitive when opening existing files.
3920
name = osutils.normpath(name)
3921
base, rel = osutils.split(name)
3922
found_rel = osutils.canonical_relpath(base, name)
3923
return (found_rel == rel
3924
and os.path.isfile(name.upper())
3925
and os.path.isfile(name.lower()))
3930
def feature_name(self):
3931
return "case-insensitive case-preserving filesystem"
3933
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3936
class _CaseInsensitiveFilesystemFeature(Feature):
3937
"""Check if underlying filesystem is case-insensitive but *not* case
3940
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3941
# more likely to be case preserving, so this case is rare.
3944
if CaseInsCasePresFilenameFeature.available():
3947
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3948
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3949
TestCaseWithMemoryTransport.TEST_ROOT = root
3951
root = TestCaseWithMemoryTransport.TEST_ROOT
3952
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3954
name_a = osutils.pathjoin(tdir, 'a')
3955
name_A = osutils.pathjoin(tdir, 'A')
3957
result = osutils.isdir(name_A)
3958
_rmtree_temp_dir(tdir)
3961
def feature_name(self):
3962
return 'case-insensitive filesystem'
3964
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3967
class _SubUnitFeature(Feature):
3968
"""Check if subunit is available."""
3977
def feature_name(self):
3980
SubUnitFeature = _SubUnitFeature()
3981
# Only define SubUnitBzrRunner if subunit is available.
3983
from subunit import TestProtocolClient
3984
class SubUnitBzrRunner(TextTestRunner):
3985
def run(self, test):
3986
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
