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
67
import bzrlib.commands
68
import bzrlib.timestamp
70
import bzrlib.inventory
71
import bzrlib.iterablefile
76
# lsprof not available
78
from bzrlib.merge import merge_inner
81
from bzrlib.smart import client, request, server
83
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (
91
from bzrlib.transport import get_transport
92
import bzrlib.transport
93
from bzrlib.transport.local import LocalURLServer
94
from bzrlib.transport.memory import MemoryServer
95
from bzrlib.transport.readonly import ReadonlyServer
96
from bzrlib.trace import mutter, note
97
from bzrlib.tests import TestUtil
98
from bzrlib.tests.http_server import HttpServer
99
from bzrlib.tests.TestUtil import (
103
from bzrlib.tests.treeshape import build_tree_contents
104
import bzrlib.version_info_formats.format_custom
105
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
107
# Mark this python module as being part of the implementation
108
# of unittest: this gives us better tracebacks where the last
109
# shown frame is the test code, not our assertXYZ.
112
default_transport = LocalURLServer
115
class ExtendedTestResult(unittest._TextTestResult):
116
"""Accepts, reports and accumulates the results of running tests.
118
Compared to the unittest version this class adds support for
119
profiling, benchmarking, stopping as soon as a test fails, and
120
skipping tests. There are further-specialized subclasses for
121
different types of display.
123
When a test finishes, in whatever way, it calls one of the addSuccess,
124
addFailure or addError classes. These in turn may redirect to a more
125
specific case for the special test results supported by our extended
128
Note that just one of these objects is fed the results from many tests.
133
def __init__(self, stream, descriptions, verbosity,
137
"""Construct new TestResult.
139
:param bench_history: Optionally, a writable file object to accumulate
142
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
143
if bench_history is not None:
144
from bzrlib.version import _get_bzr_source_tree
145
src_tree = _get_bzr_source_tree()
148
revision_id = src_tree.get_parent_ids()[0]
150
# XXX: if this is a brand new tree, do the same as if there
154
# XXX: If there's no branch, what should we do?
156
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
157
self._bench_history = bench_history
158
self.ui = ui.ui_factory
159
self.num_tests = num_tests
161
self.failure_count = 0
162
self.known_failure_count = 0
164
self.not_applicable_count = 0
165
self.unsupported = {}
167
self._overall_start_time = time.time()
169
def _extractBenchmarkTime(self, testCase):
170
"""Add a benchmark time for the current test case."""
171
return getattr(testCase, "_benchtime", None)
173
def _elapsedTestTimeString(self):
174
"""Return a time string for the overall time the current test has taken."""
175
return self._formatTime(time.time() - self._start_time)
177
def _testTimeString(self, testCase):
178
benchmark_time = self._extractBenchmarkTime(testCase)
179
if benchmark_time is not None:
181
self._formatTime(benchmark_time),
182
self._elapsedTestTimeString())
184
return " %s" % self._elapsedTestTimeString()
186
def _formatTime(self, seconds):
187
"""Format seconds as milliseconds with leading spaces."""
188
# some benchmarks can take thousands of seconds to run, so we need 8
190
return "%8dms" % (1000 * seconds)
192
def _shortened_test_description(self, test):
194
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
197
def startTest(self, test):
198
unittest.TestResult.startTest(self, test)
199
self.report_test_start(test)
200
test.number = self.count
201
self._recordTestStartTime()
203
def _recordTestStartTime(self):
204
"""Record that a test has started."""
205
self._start_time = time.time()
207
def _cleanupLogFile(self, test):
208
# We can only do this if we have one of our TestCases, not if
210
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
211
if setKeepLogfile is not None:
214
def addError(self, test, err):
215
"""Tell result that test finished with an error.
217
Called from the TestCase run() method when the test
218
fails with an unexpected error.
220
self._testConcluded(test)
221
if isinstance(err[1], TestNotApplicable):
222
return self._addNotApplicable(test, err)
223
elif isinstance(err[1], UnavailableFeature):
224
return self.addNotSupported(test, err[1].args[0])
226
unittest.TestResult.addError(self, test, err)
227
self.error_count += 1
228
self.report_error(test, err)
231
self._cleanupLogFile(test)
233
def addFailure(self, test, err):
234
"""Tell result that test failed.
236
Called from the TestCase run() method when the test
237
fails because e.g. an assert() method failed.
239
self._testConcluded(test)
240
if isinstance(err[1], KnownFailure):
241
return self._addKnownFailure(test, err)
243
unittest.TestResult.addFailure(self, test, err)
244
self.failure_count += 1
245
self.report_failure(test, err)
248
self._cleanupLogFile(test)
250
def addSuccess(self, test):
251
"""Tell result that test completed successfully.
253
Called from the TestCase run()
255
self._testConcluded(test)
256
if self._bench_history is not None:
257
benchmark_time = self._extractBenchmarkTime(test)
258
if benchmark_time is not None:
259
self._bench_history.write("%s %s\n" % (
260
self._formatTime(benchmark_time),
262
self.report_success(test)
263
self._cleanupLogFile(test)
264
unittest.TestResult.addSuccess(self, test)
265
test._log_contents = ''
267
def _testConcluded(self, test):
268
"""Common code when a test has finished.
270
Called regardless of whether it succeded, failed, etc.
274
def _addKnownFailure(self, test, err):
275
self.known_failure_count += 1
276
self.report_known_failure(test, err)
278
def addNotSupported(self, test, feature):
279
"""The test will not be run because of a missing feature.
281
# this can be called in two different ways: it may be that the
282
# test started running, and then raised (through addError)
283
# UnavailableFeature. Alternatively this method can be called
284
# while probing for features before running the tests; in that
285
# case we will see startTest and stopTest, but the test will never
287
self.unsupported.setdefault(str(feature), 0)
288
self.unsupported[str(feature)] += 1
289
self.report_unsupported(test, feature)
291
def addSkip(self, test, reason):
292
"""A test has not run for 'reason'."""
294
self.report_skip(test, reason)
296
def _addNotApplicable(self, test, skip_excinfo):
297
if isinstance(skip_excinfo[1], TestNotApplicable):
298
self.not_applicable_count += 1
299
self.report_not_applicable(test, skip_excinfo)
302
except KeyboardInterrupt:
305
self.addError(test, test.exc_info())
307
# seems best to treat this as success from point-of-view of unittest
308
# -- it actually does nothing so it barely matters :)
309
unittest.TestResult.addSuccess(self, test)
310
test._log_contents = ''
312
def printErrorList(self, flavour, errors):
313
for test, err in errors:
314
self.stream.writeln(self.separator1)
315
self.stream.write("%s: " % flavour)
316
self.stream.writeln(self.getDescription(test))
317
if getattr(test, '_get_log', None) is not None:
318
self.stream.write('\n')
320
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
321
self.stream.write('\n')
322
self.stream.write(test._get_log())
323
self.stream.write('\n')
325
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
326
self.stream.write('\n')
327
self.stream.writeln(self.separator2)
328
self.stream.writeln("%s" % err)
333
def report_cleaning_up(self):
336
def report_success(self, test):
339
def wasStrictlySuccessful(self):
340
if self.unsupported or self.known_failure_count:
342
return self.wasSuccessful()
345
class TextTestResult(ExtendedTestResult):
346
"""Displays progress and results of tests in text form"""
348
def __init__(self, stream, descriptions, verbosity,
353
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
354
bench_history, num_tests)
356
self.pb = self.ui.nested_progress_bar()
357
self._supplied_pb = False
360
self._supplied_pb = True
361
self.pb.show_pct = False
362
self.pb.show_spinner = False
363
self.pb.show_eta = False,
364
self.pb.show_count = False
365
self.pb.show_bar = False
367
def report_starting(self):
368
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
370
def _progress_prefix_text(self):
371
# the longer this text, the less space we have to show the test
373
a = '[%d' % self.count # total that have been run
374
# tests skipped as known not to be relevant are not important enough
376
## if self.skip_count:
377
## a += ', %d skip' % self.skip_count
378
## if self.known_failure_count:
379
## a += '+%dX' % self.known_failure_count
380
if self.num_tests is not None:
381
a +='/%d' % self.num_tests
383
runtime = time.time() - self._overall_start_time
385
a += '%dm%ds' % (runtime / 60, runtime % 60)
389
a += ', %d err' % self.error_count
390
if self.failure_count:
391
a += ', %d fail' % self.failure_count
393
a += ', %d missing' % len(self.unsupported)
397
def report_test_start(self, test):
400
self._progress_prefix_text()
402
+ self._shortened_test_description(test))
404
def _test_description(self, test):
405
return self._shortened_test_description(test)
407
def report_error(self, test, err):
408
self.pb.note('ERROR: %s\n %s\n',
409
self._test_description(test),
413
def report_failure(self, test, err):
414
self.pb.note('FAIL: %s\n %s\n',
415
self._test_description(test),
419
def report_known_failure(self, test, err):
420
self.pb.note('XFAIL: %s\n%s\n',
421
self._test_description(test), err[1])
423
def report_skip(self, test, reason):
426
def report_not_applicable(self, test, skip_excinfo):
429
def report_unsupported(self, test, feature):
430
"""test cannot be run because feature is missing."""
432
def report_cleaning_up(self):
433
self.pb.update('Cleaning up')
436
if not self._supplied_pb:
440
class VerboseTestResult(ExtendedTestResult):
441
"""Produce long output, with one line per test run plus times"""
443
def _ellipsize_to_right(self, a_string, final_width):
444
"""Truncate and pad a string, keeping the right hand side"""
445
if len(a_string) > final_width:
446
result = '...' + a_string[3-final_width:]
449
return result.ljust(final_width)
451
def report_starting(self):
452
self.stream.write('running %d tests...\n' % self.num_tests)
454
def report_test_start(self, test):
456
name = self._shortened_test_description(test)
457
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
458
# numbers, plus a trailing blank
459
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
460
self.stream.write(self._ellipsize_to_right(name,
461
osutils.terminal_width()-30))
464
def _error_summary(self, err):
466
return '%s%s' % (indent, err[1])
468
def report_error(self, test, err):
469
self.stream.writeln('ERROR %s\n%s'
470
% (self._testTimeString(test),
471
self._error_summary(err)))
473
def report_failure(self, test, err):
474
self.stream.writeln(' FAIL %s\n%s'
475
% (self._testTimeString(test),
476
self._error_summary(err)))
478
def report_known_failure(self, test, err):
479
self.stream.writeln('XFAIL %s\n%s'
480
% (self._testTimeString(test),
481
self._error_summary(err)))
483
def report_success(self, test):
484
self.stream.writeln(' OK %s' % self._testTimeString(test))
485
for bench_called, stats in getattr(test, '_benchcalls', []):
486
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
487
stats.pprint(file=self.stream)
488
# flush the stream so that we get smooth output. This verbose mode is
489
# used to show the output in PQM.
492
def report_skip(self, test, reason):
493
self.stream.writeln(' SKIP %s\n%s'
494
% (self._testTimeString(test), reason))
496
def report_not_applicable(self, test, skip_excinfo):
497
self.stream.writeln(' N/A %s\n%s'
498
% (self._testTimeString(test),
499
self._error_summary(skip_excinfo)))
501
def report_unsupported(self, test, feature):
502
"""test cannot be run because feature is missing."""
503
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
504
%(self._testTimeString(test), feature))
507
class TextTestRunner(object):
508
stop_on_failure = False
517
self.stream = unittest._WritelnDecorator(stream)
518
self.descriptions = descriptions
519
self.verbosity = verbosity
520
self._bench_history = bench_history
521
self.list_only = list_only
524
"Run the given test case or test suite."
525
startTime = time.time()
526
if self.verbosity == 1:
527
result_class = TextTestResult
528
elif self.verbosity >= 2:
529
result_class = VerboseTestResult
530
result = result_class(self.stream,
533
bench_history=self._bench_history,
534
num_tests=test.countTestCases(),
536
result.stop_early = self.stop_on_failure
537
result.report_starting()
539
if self.verbosity >= 2:
540
self.stream.writeln("Listing tests only ...\n")
542
for t in iter_suite_tests(test):
543
self.stream.writeln("%s" % (t.id()))
545
actionTaken = "Listed"
552
if isinstance(test, testtools.ConcurrentTestSuite):
553
# We need to catch bzr specific behaviors
554
test.run(BZRTransformingResult(result))
557
run = result.testsRun
559
stopTime = time.time()
560
timeTaken = stopTime - startTime
562
self.stream.writeln(result.separator2)
563
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
564
run, run != 1 and "s" or "", timeTaken))
565
self.stream.writeln()
566
if not result.wasSuccessful():
567
self.stream.write("FAILED (")
568
failed, errored = map(len, (result.failures, result.errors))
570
self.stream.write("failures=%d" % failed)
572
if failed: self.stream.write(", ")
573
self.stream.write("errors=%d" % errored)
574
if result.known_failure_count:
575
if failed or errored: self.stream.write(", ")
576
self.stream.write("known_failure_count=%d" %
577
result.known_failure_count)
578
self.stream.writeln(")")
580
if result.known_failure_count:
581
self.stream.writeln("OK (known_failures=%d)" %
582
result.known_failure_count)
584
self.stream.writeln("OK")
585
if result.skip_count > 0:
586
skipped = result.skip_count
587
self.stream.writeln('%d test%s skipped' %
588
(skipped, skipped != 1 and "s" or ""))
589
if result.unsupported:
590
for feature, count in sorted(result.unsupported.items()):
591
self.stream.writeln("Missing feature '%s' skipped %d tests." %
597
def iter_suite_tests(suite):
598
"""Return all tests in a suite, recursing through nested suites"""
599
if isinstance(suite, unittest.TestCase):
601
elif isinstance(suite, unittest.TestSuite):
603
for r in iter_suite_tests(item):
606
raise Exception('unknown type %r for object %r'
607
% (type(suite), suite))
610
class TestSkipped(Exception):
611
"""Indicates that a test was intentionally skipped, rather than failing."""
614
class TestNotApplicable(TestSkipped):
615
"""A test is not applicable to the situation where it was run.
617
This is only normally raised by parameterized tests, if they find that
618
the instance they're constructed upon does not support one aspect
623
class KnownFailure(AssertionError):
624
"""Indicates that a test failed in a precisely expected manner.
626
Such failures dont block the whole test suite from passing because they are
627
indicators of partially completed code or of future work. We have an
628
explicit error for them so that we can ensure that they are always visible:
629
KnownFailures are always shown in the output of bzr selftest.
633
class UnavailableFeature(Exception):
634
"""A feature required for this test was not available.
636
The feature should be used to construct the exception.
640
class CommandFailed(Exception):
644
class StringIOWrapper(object):
645
"""A wrapper around cStringIO which just adds an encoding attribute.
647
Internally we can check sys.stdout to see what the output encoding
648
should be. However, cStringIO has no encoding attribute that we can
649
set. So we wrap it instead.
654
def __init__(self, s=None):
656
self.__dict__['_cstring'] = StringIO(s)
658
self.__dict__['_cstring'] = StringIO()
660
def __getattr__(self, name, getattr=getattr):
661
return getattr(self.__dict__['_cstring'], name)
663
def __setattr__(self, name, val):
664
if name == 'encoding':
665
self.__dict__['encoding'] = val
667
return setattr(self._cstring, name, val)
670
class TestUIFactory(ui.CLIUIFactory):
671
"""A UI Factory for testing.
673
Hide the progress bar but emit note()s.
675
Allows get_password to be tested without real tty attached.
682
super(TestUIFactory, self).__init__()
683
if stdin is not None:
684
# We use a StringIOWrapper to be able to test various
685
# encodings, but the user is still responsible to
686
# encode the string and to set the encoding attribute
687
# of StringIOWrapper.
688
self.stdin = StringIOWrapper(stdin)
690
self.stdout = sys.stdout
694
self.stderr = sys.stderr
699
"""See progress.ProgressBar.clear()."""
701
def clear_term(self):
702
"""See progress.ProgressBar.clear_term()."""
704
def clear_term(self):
705
"""See progress.ProgressBar.clear_term()."""
708
"""See progress.ProgressBar.finished()."""
710
def note(self, fmt_string, *args, **kwargs):
711
"""See progress.ProgressBar.note()."""
712
self.stdout.write((fmt_string + "\n") % args)
714
def progress_bar(self):
717
def nested_progress_bar(self):
720
def update(self, message, count=None, total=None):
721
"""See progress.ProgressBar.update()."""
723
def get_non_echoed_password(self, prompt):
724
"""Get password from stdin without trying to handle the echo mode"""
726
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
727
password = self.stdin.readline()
730
if password[-1] == '\n':
731
password = password[:-1]
735
def _report_leaked_threads():
736
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
737
TestCase._first_thread_leaker_id,
738
TestCase._leaking_threads_tests)
741
class TestCase(unittest.TestCase):
742
"""Base class for bzr unit tests.
744
Tests that need access to disk resources should subclass
745
TestCaseInTempDir not TestCase.
747
Error and debug log messages are redirected from their usual
748
location into a temporary file, the contents of which can be
749
retrieved by _get_log(). We use a real OS file, not an in-memory object,
750
so that it can also capture file IO. When the test completes this file
751
is read into memory and removed from disk.
753
There are also convenience functions to invoke bzr's command-line
754
routine, and to build and check bzr trees.
756
In addition to the usual method of overriding tearDown(), this class also
757
allows subclasses to register functions into the _cleanups list, which is
758
run in order as the object is torn down. It's less likely this will be
759
accidentally overlooked.
762
_active_threads = None
763
_leaking_threads_tests = 0
764
_first_thread_leaker_id = None
765
_log_file_name = None
767
_keep_log_file = False
768
# record lsprof data when performing benchmark calls.
769
_gather_lsprof_in_benchmarks = False
770
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
771
'_log_contents', '_log_file_name', '_benchtime',
772
'_TestCase__testMethodName')
774
def __init__(self, methodName='testMethod'):
775
super(TestCase, self).__init__(methodName)
777
self._bzr_test_setUp_run = False
778
self._bzr_test_tearDown_run = False
781
unittest.TestCase.setUp(self)
782
self._bzr_test_setUp_run = True
783
self._cleanEnvironment()
786
self._benchcalls = []
787
self._benchtime = None
789
self._clear_debug_flags()
790
TestCase._active_threads = threading.activeCount()
791
self.addCleanup(self._check_leaked_threads)
796
pdb.Pdb().set_trace(sys._getframe().f_back)
798
def _check_leaked_threads(self):
799
active = threading.activeCount()
800
leaked_threads = active - TestCase._active_threads
801
TestCase._active_threads = active
803
TestCase._leaking_threads_tests += 1
804
if TestCase._first_thread_leaker_id is None:
805
TestCase._first_thread_leaker_id = self.id()
806
# we're not specifically told when all tests are finished.
807
# This will do. We use a function to avoid keeping a reference
808
# to a TestCase object.
809
atexit.register(_report_leaked_threads)
811
def _clear_debug_flags(self):
812
"""Prevent externally set debug flags affecting tests.
814
Tests that want to use debug flags can just set them in the
815
debug_flags set during setup/teardown.
817
self._preserved_debug_flags = set(debug.debug_flags)
818
if 'allow_debug' not in selftest_debug_flags:
819
debug.debug_flags.clear()
820
self.addCleanup(self._restore_debug_flags)
822
def _clear_hooks(self):
823
# prevent hooks affecting tests
824
self._preserved_hooks = {}
825
for key, factory in hooks.known_hooks.items():
826
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
827
current_hooks = hooks.known_hooks_key_to_object(key)
828
self._preserved_hooks[parent] = (name, current_hooks)
829
self.addCleanup(self._restoreHooks)
830
for key, factory in hooks.known_hooks.items():
831
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
832
setattr(parent, name, factory())
833
# this hook should always be installed
834
request._install_hook()
836
def _silenceUI(self):
837
"""Turn off UI for duration of test"""
838
# by default the UI is off; tests can turn it on if they want it.
839
saved = ui.ui_factory
841
ui.ui_factory = saved
842
ui.ui_factory = ui.SilentUIFactory()
843
self.addCleanup(_restore)
845
def _ndiff_strings(self, a, b):
846
"""Return ndiff between two strings containing lines.
848
A trailing newline is added if missing to make the strings
850
if b and b[-1] != '\n':
852
if a and a[-1] != '\n':
854
difflines = difflib.ndiff(a.splitlines(True),
856
linejunk=lambda x: False,
857
charjunk=lambda x: False)
858
return ''.join(difflines)
860
def assertEqual(self, a, b, message=''):
864
except UnicodeError, e:
865
# If we can't compare without getting a UnicodeError, then
866
# obviously they are different
867
mutter('UnicodeError: %s', e)
870
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
872
pformat(a), pformat(b)))
874
assertEquals = assertEqual
876
def assertEqualDiff(self, a, b, message=None):
877
"""Assert two texts are equal, if not raise an exception.
879
This is intended for use with multi-line strings where it can
880
be hard to find the differences by eye.
882
# TODO: perhaps override assertEquals to call this for strings?
886
message = "texts not equal:\n"
888
message = 'first string is missing a final newline.\n'
890
message = 'second string is missing a final newline.\n'
891
raise AssertionError(message +
892
self._ndiff_strings(a, b))
894
def assertEqualMode(self, mode, mode_test):
895
self.assertEqual(mode, mode_test,
896
'mode mismatch %o != %o' % (mode, mode_test))
898
def assertEqualStat(self, expected, actual):
899
"""assert that expected and actual are the same stat result.
901
:param expected: A stat result.
902
:param actual: A stat result.
903
:raises AssertionError: If the expected and actual stat values differ
906
self.assertEqual(expected.st_size, actual.st_size)
907
self.assertEqual(expected.st_mtime, actual.st_mtime)
908
self.assertEqual(expected.st_ctime, actual.st_ctime)
909
self.assertEqual(expected.st_dev, actual.st_dev)
910
self.assertEqual(expected.st_ino, actual.st_ino)
911
self.assertEqual(expected.st_mode, actual.st_mode)
913
def assertLength(self, length, obj_with_len):
914
"""Assert that obj_with_len is of length length."""
915
if len(obj_with_len) != length:
916
self.fail("Incorrect length: wanted %d, got %d for %r" % (
917
length, len(obj_with_len), obj_with_len))
919
def assertPositive(self, val):
920
"""Assert that val is greater than 0."""
921
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
923
def assertNegative(self, val):
924
"""Assert that val is less than 0."""
925
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
927
def assertStartsWith(self, s, prefix):
928
if not s.startswith(prefix):
929
raise AssertionError('string %r does not start with %r' % (s, prefix))
931
def assertEndsWith(self, s, suffix):
932
"""Asserts that s ends with suffix."""
933
if not s.endswith(suffix):
934
raise AssertionError('string %r does not end with %r' % (s, suffix))
936
def assertContainsRe(self, haystack, needle_re, flags=0):
937
"""Assert that a contains something matching a regular expression."""
938
if not re.search(needle_re, haystack, flags):
939
if '\n' in haystack or len(haystack) > 60:
940
# a long string, format it in a more readable way
941
raise AssertionError(
942
'pattern "%s" not found in\n"""\\\n%s"""\n'
943
% (needle_re, haystack))
945
raise AssertionError('pattern "%s" not found in "%s"'
946
% (needle_re, haystack))
948
def assertNotContainsRe(self, haystack, needle_re, flags=0):
949
"""Assert that a does not match a regular expression"""
950
if re.search(needle_re, haystack, flags):
951
raise AssertionError('pattern "%s" found in "%s"'
952
% (needle_re, haystack))
954
def assertSubset(self, sublist, superlist):
955
"""Assert that every entry in sublist is present in superlist."""
956
missing = set(sublist) - set(superlist)
958
raise AssertionError("value(s) %r not present in container %r" %
959
(missing, superlist))
961
def assertListRaises(self, excClass, func, *args, **kwargs):
962
"""Fail unless excClass is raised when the iterator from func is used.
964
Many functions can return generators this makes sure
965
to wrap them in a list() call to make sure the whole generator
966
is run, and that the proper exception is raised.
969
list(func(*args, **kwargs))
973
if getattr(excClass,'__name__', None) is not None:
974
excName = excClass.__name__
976
excName = str(excClass)
977
raise self.failureException, "%s not raised" % excName
979
def assertRaises(self, excClass, callableObj, *args, **kwargs):
980
"""Assert that a callable raises a particular exception.
982
:param excClass: As for the except statement, this may be either an
983
exception class, or a tuple of classes.
984
:param callableObj: A callable, will be passed ``*args`` and
987
Returns the exception so that you can examine it.
990
callableObj(*args, **kwargs)
994
if getattr(excClass,'__name__', None) is not None:
995
excName = excClass.__name__
998
excName = str(excClass)
999
raise self.failureException, "%s not raised" % excName
1001
def assertIs(self, left, right, message=None):
1002
if not (left is right):
1003
if message is not None:
1004
raise AssertionError(message)
1006
raise AssertionError("%r is not %r." % (left, right))
1008
def assertIsNot(self, left, right, message=None):
1010
if message is not None:
1011
raise AssertionError(message)
1013
raise AssertionError("%r is %r." % (left, right))
1015
def assertTransportMode(self, transport, path, mode):
1016
"""Fail if a path does not have mode mode.
1018
If modes are not supported on this transport, the assertion is ignored.
1020
if not transport._can_roundtrip_unix_modebits():
1022
path_stat = transport.stat(path)
1023
actual_mode = stat.S_IMODE(path_stat.st_mode)
1024
self.assertEqual(mode, actual_mode,
1025
'mode of %r incorrect (%s != %s)'
1026
% (path, oct(mode), oct(actual_mode)))
1028
def assertIsSameRealPath(self, path1, path2):
1029
"""Fail if path1 and path2 points to different files"""
1030
self.assertEqual(osutils.realpath(path1),
1031
osutils.realpath(path2),
1032
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1034
def assertIsInstance(self, obj, kls):
1035
"""Fail if obj is not an instance of kls"""
1036
if not isinstance(obj, kls):
1037
self.fail("%r is an instance of %s rather than %s" % (
1038
obj, obj.__class__, kls))
1040
def expectFailure(self, reason, assertion, *args, **kwargs):
1041
"""Invoke a test, expecting it to fail for the given reason.
1043
This is for assertions that ought to succeed, but currently fail.
1044
(The failure is *expected* but not *wanted*.) Please be very precise
1045
about the failure you're expecting. If a new bug is introduced,
1046
AssertionError should be raised, not KnownFailure.
1048
Frequently, expectFailure should be followed by an opposite assertion.
1051
Intended to be used with a callable that raises AssertionError as the
1052
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1054
Raises KnownFailure if the test fails. Raises AssertionError if the
1059
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1061
self.assertEqual(42, dynamic_val)
1063
This means that a dynamic_val of 54 will cause the test to raise
1064
a KnownFailure. Once math is fixed and the expectFailure is removed,
1065
only a dynamic_val of 42 will allow the test to pass. Anything other
1066
than 54 or 42 will cause an AssertionError.
1069
assertion(*args, **kwargs)
1070
except AssertionError:
1071
raise KnownFailure(reason)
1073
self.fail('Unexpected success. Should have failed: %s' % reason)
1075
def assertFileEqual(self, content, path):
1076
"""Fail if path does not contain 'content'."""
1077
self.failUnlessExists(path)
1078
f = file(path, 'rb')
1083
self.assertEqualDiff(content, s)
1085
def failUnlessExists(self, path):
1086
"""Fail unless path or paths, which may be abs or relative, exist."""
1087
if not isinstance(path, basestring):
1089
self.failUnlessExists(p)
1091
self.failUnless(osutils.lexists(path),path+" does not exist")
1093
def failIfExists(self, path):
1094
"""Fail if path or paths, which may be abs or relative, exist."""
1095
if not isinstance(path, basestring):
1097
self.failIfExists(p)
1099
self.failIf(osutils.lexists(path),path+" exists")
1101
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1102
"""A helper for callDeprecated and applyDeprecated.
1104
:param a_callable: A callable to call.
1105
:param args: The positional arguments for the callable
1106
:param kwargs: The keyword arguments for the callable
1107
:return: A tuple (warnings, result). result is the result of calling
1108
a_callable(``*args``, ``**kwargs``).
1111
def capture_warnings(msg, cls=None, stacklevel=None):
1112
# we've hooked into a deprecation specific callpath,
1113
# only deprecations should getting sent via it.
1114
self.assertEqual(cls, DeprecationWarning)
1115
local_warnings.append(msg)
1116
original_warning_method = symbol_versioning.warn
1117
symbol_versioning.set_warning_method(capture_warnings)
1119
result = a_callable(*args, **kwargs)
1121
symbol_versioning.set_warning_method(original_warning_method)
1122
return (local_warnings, result)
1124
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1125
"""Call a deprecated callable without warning the user.
1127
Note that this only captures warnings raised by symbol_versioning.warn,
1128
not other callers that go direct to the warning module.
1130
To test that a deprecated method raises an error, do something like
1133
self.assertRaises(errors.ReservedId,
1134
self.applyDeprecated,
1135
deprecated_in((1, 5, 0)),
1139
:param deprecation_format: The deprecation format that the callable
1140
should have been deprecated with. This is the same type as the
1141
parameter to deprecated_method/deprecated_function. If the
1142
callable is not deprecated with this format, an assertion error
1144
:param a_callable: A callable to call. This may be a bound method or
1145
a regular function. It will be called with ``*args`` and
1147
:param args: The positional arguments for the callable
1148
:param kwargs: The keyword arguments for the callable
1149
:return: The result of a_callable(``*args``, ``**kwargs``)
1151
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1153
expected_first_warning = symbol_versioning.deprecation_string(
1154
a_callable, deprecation_format)
1155
if len(call_warnings) == 0:
1156
self.fail("No deprecation warning generated by call to %s" %
1158
self.assertEqual(expected_first_warning, call_warnings[0])
1161
def callCatchWarnings(self, fn, *args, **kw):
1162
"""Call a callable that raises python warnings.
1164
The caller's responsible for examining the returned warnings.
1166
If the callable raises an exception, the exception is not
1167
caught and propagates up to the caller. In that case, the list
1168
of warnings is not available.
1170
:returns: ([warning_object, ...], fn_result)
1172
# XXX: This is not perfect, because it completely overrides the
1173
# warnings filters, and some code may depend on suppressing particular
1174
# warnings. It's the easiest way to insulate ourselves from -Werror,
1175
# though. -- Andrew, 20071062
1177
def _catcher(message, category, filename, lineno, file=None, line=None):
1178
# despite the name, 'message' is normally(?) a Warning subclass
1180
wlist.append(message)
1181
saved_showwarning = warnings.showwarning
1182
saved_filters = warnings.filters
1184
warnings.showwarning = _catcher
1185
warnings.filters = []
1186
result = fn(*args, **kw)
1188
warnings.showwarning = saved_showwarning
1189
warnings.filters = saved_filters
1190
return wlist, result
1192
def callDeprecated(self, expected, callable, *args, **kwargs):
1193
"""Assert that a callable is deprecated in a particular way.
1195
This is a very precise test for unusual requirements. The
1196
applyDeprecated helper function is probably more suited for most tests
1197
as it allows you to simply specify the deprecation format being used
1198
and will ensure that that is issued for the function being called.
1200
Note that this only captures warnings raised by symbol_versioning.warn,
1201
not other callers that go direct to the warning module. To catch
1202
general warnings, use callCatchWarnings.
1204
:param expected: a list of the deprecation warnings expected, in order
1205
:param callable: The callable to call
1206
:param args: The positional arguments for the callable
1207
:param kwargs: The keyword arguments for the callable
1209
call_warnings, result = self._capture_deprecation_warnings(callable,
1211
self.assertEqual(expected, call_warnings)
1214
def _startLogFile(self):
1215
"""Send bzr and test log messages to a temporary file.
1217
The file is removed as the test is torn down.
1219
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1220
self._log_file = os.fdopen(fileno, 'w+')
1221
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1222
self._log_file_name = name
1223
self.addCleanup(self._finishLogFile)
1225
def _finishLogFile(self):
1226
"""Finished with the log file.
1228
Close the file and delete it, unless setKeepLogfile was called.
1230
if self._log_file is None:
1232
bzrlib.trace.pop_log_file(self._log_memento)
1233
self._log_file.close()
1234
self._log_file = None
1235
if not self._keep_log_file:
1236
os.remove(self._log_file_name)
1237
self._log_file_name = None
1239
def setKeepLogfile(self):
1240
"""Make the logfile not be deleted when _finishLogFile is called."""
1241
self._keep_log_file = True
1243
def addCleanup(self, callable, *args, **kwargs):
1244
"""Arrange to run a callable when this case is torn down.
1246
Callables are run in the reverse of the order they are registered,
1247
ie last-in first-out.
1249
self._cleanups.append((callable, args, kwargs))
1251
def _cleanEnvironment(self):
1253
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1254
'HOME': os.getcwd(),
1255
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1256
# tests do check our impls match APPDATA
1257
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1261
'BZREMAIL': None, # may still be present in the environment
1263
'BZR_PROGRESS_BAR': None,
1265
'BZR_PLUGIN_PATH': None,
1267
'SSH_AUTH_SOCK': None,
1271
'https_proxy': None,
1272
'HTTPS_PROXY': None,
1277
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1278
# least. If you do (care), please update this comment
1282
'BZR_REMOTE_PATH': None,
1285
self.addCleanup(self._restoreEnvironment)
1286
for name, value in new_env.iteritems():
1287
self._captureVar(name, value)
1289
def _captureVar(self, name, newvalue):
1290
"""Set an environment variable, and reset it when finished."""
1291
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1293
def _restore_debug_flags(self):
1294
debug.debug_flags.clear()
1295
debug.debug_flags.update(self._preserved_debug_flags)
1297
def _restoreEnvironment(self):
1298
for name, value in self.__old_env.iteritems():
1299
osutils.set_or_unset_env(name, value)
1301
def _restoreHooks(self):
1302
for klass, (name, hooks) in self._preserved_hooks.items():
1303
setattr(klass, name, hooks)
1305
def knownFailure(self, reason):
1306
"""This test has failed for some known reason."""
1307
raise KnownFailure(reason)
1309
def _do_skip(self, result, reason):
1310
addSkip = getattr(result, 'addSkip', None)
1311
if not callable(addSkip):
1312
result.addError(self, sys.exc_info())
1314
addSkip(self, reason)
1316
def run(self, result=None):
1317
if result is None: result = self.defaultTestResult()
1318
for feature in getattr(self, '_test_needs_features', []):
1319
if not feature.available():
1320
result.startTest(self)
1321
if getattr(result, 'addNotSupported', None):
1322
result.addNotSupported(self, feature)
1324
result.addSuccess(self)
1325
result.stopTest(self)
1329
result.startTest(self)
1330
absent_attr = object()
1332
method_name = getattr(self, '_testMethodName', absent_attr)
1333
if method_name is absent_attr:
1335
method_name = getattr(self, '_TestCase__testMethodName')
1336
testMethod = getattr(self, method_name)
1340
if not self._bzr_test_setUp_run:
1342
"test setUp did not invoke "
1343
"bzrlib.tests.TestCase's setUp")
1344
except KeyboardInterrupt:
1346
except TestSkipped, e:
1347
self._do_skip(result, e.args[0])
1351
result.addError(self, sys.exc_info())
1358
except self.failureException:
1359
result.addFailure(self, sys.exc_info())
1360
except TestSkipped, e:
1362
reason = "No reason given."
1365
self._do_skip(result, reason)
1366
except KeyboardInterrupt:
1369
result.addError(self, sys.exc_info())
1373
if not self._bzr_test_tearDown_run:
1375
"test tearDown did not invoke "
1376
"bzrlib.tests.TestCase's tearDown")
1377
except KeyboardInterrupt:
1380
result.addError(self, sys.exc_info())
1382
if ok: result.addSuccess(self)
1384
result.stopTest(self)
1386
except TestNotApplicable:
1387
# Not moved from the result [yet].
1389
except KeyboardInterrupt:
1393
absent_attr = object()
1394
for attr_name in self.attrs_to_keep:
1395
attr = getattr(self, attr_name, absent_attr)
1396
if attr is not absent_attr:
1397
saved_attrs[attr_name] = attr
1398
self.__dict__ = saved_attrs
1401
self._bzr_test_tearDown_run = True
1403
self._log_contents = ''
1404
unittest.TestCase.tearDown(self)
1406
def time(self, callable, *args, **kwargs):
1407
"""Run callable and accrue the time it takes to the benchmark time.
1409
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1410
this will cause lsprofile statistics to be gathered and stored in
1413
if self._benchtime is None:
1417
if not self._gather_lsprof_in_benchmarks:
1418
return callable(*args, **kwargs)
1420
# record this benchmark
1421
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1423
self._benchcalls.append(((callable, args, kwargs), stats))
1426
self._benchtime += time.time() - start
1428
def _runCleanups(self):
1429
"""Run registered cleanup functions.
1431
This should only be called from TestCase.tearDown.
1433
# TODO: Perhaps this should keep running cleanups even if
1434
# one of them fails?
1436
# Actually pop the cleanups from the list so tearDown running
1437
# twice is safe (this happens for skipped tests).
1438
while self._cleanups:
1439
cleanup, args, kwargs = self._cleanups.pop()
1440
cleanup(*args, **kwargs)
1442
def log(self, *args):
1445
def _get_log(self, keep_log_file=False):
1446
"""Get the log from bzrlib.trace calls from this test.
1448
:param keep_log_file: When True, if the log is still a file on disk
1449
leave it as a file on disk. When False, if the log is still a file
1450
on disk, the log file is deleted and the log preserved as
1452
:return: A string containing the log.
1454
# flush the log file, to get all content
1456
if bzrlib.trace._trace_file:
1457
bzrlib.trace._trace_file.flush()
1458
if self._log_contents:
1459
# XXX: this can hardly contain the content flushed above --vila
1461
return self._log_contents
1462
if self._log_file_name is not None:
1463
logfile = open(self._log_file_name)
1465
log_contents = logfile.read()
1468
if not keep_log_file:
1469
self._log_contents = log_contents
1471
os.remove(self._log_file_name)
1473
if sys.platform == 'win32' and e.errno == errno.EACCES:
1474
sys.stderr.write(('Unable to delete log file '
1475
' %r\n' % self._log_file_name))
1480
return "DELETED log file to reduce memory footprint"
1482
def requireFeature(self, feature):
1483
"""This test requires a specific feature is available.
1485
:raises UnavailableFeature: When feature is not available.
1487
if not feature.available():
1488
raise UnavailableFeature(feature)
1490
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1492
"""Run bazaar command line, splitting up a string command line."""
1493
if isinstance(args, basestring):
1494
# shlex don't understand unicode strings,
1495
# so args should be plain string (bialix 20070906)
1496
args = list(shlex.split(str(args)))
1497
return self._run_bzr_core(args, retcode=retcode,
1498
encoding=encoding, stdin=stdin, working_dir=working_dir,
1501
def _run_bzr_core(self, args, retcode, encoding, stdin,
1503
if encoding is None:
1504
encoding = osutils.get_user_encoding()
1505
stdout = StringIOWrapper()
1506
stderr = StringIOWrapper()
1507
stdout.encoding = encoding
1508
stderr.encoding = encoding
1510
self.log('run bzr: %r', args)
1511
# FIXME: don't call into logging here
1512
handler = logging.StreamHandler(stderr)
1513
handler.setLevel(logging.INFO)
1514
logger = logging.getLogger('')
1515
logger.addHandler(handler)
1516
old_ui_factory = ui.ui_factory
1517
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1520
if working_dir is not None:
1521
cwd = osutils.getcwd()
1522
os.chdir(working_dir)
1525
result = self.apply_redirected(ui.ui_factory.stdin,
1527
bzrlib.commands.run_bzr_catch_user_errors,
1530
logger.removeHandler(handler)
1531
ui.ui_factory = old_ui_factory
1535
out = stdout.getvalue()
1536
err = stderr.getvalue()
1538
self.log('output:\n%r', out)
1540
self.log('errors:\n%r', err)
1541
if retcode is not None:
1542
self.assertEquals(retcode, result,
1543
message='Unexpected return code')
1546
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1547
working_dir=None, error_regexes=[], output_encoding=None):
1548
"""Invoke bzr, as if it were run from the command line.
1550
The argument list should not include the bzr program name - the
1551
first argument is normally the bzr command. Arguments may be
1552
passed in three ways:
1554
1- A list of strings, eg ["commit", "a"]. This is recommended
1555
when the command contains whitespace or metacharacters, or
1556
is built up at run time.
1558
2- A single string, eg "add a". This is the most convenient
1559
for hardcoded commands.
1561
This runs bzr through the interface that catches and reports
1562
errors, and with logging set to something approximating the
1563
default, so that error reporting can be checked.
1565
This should be the main method for tests that want to exercise the
1566
overall behavior of the bzr application (rather than a unit test
1567
or a functional test of the library.)
1569
This sends the stdout/stderr results into the test's log,
1570
where it may be useful for debugging. See also run_captured.
1572
:keyword stdin: A string to be used as stdin for the command.
1573
:keyword retcode: The status code the command should return;
1575
:keyword working_dir: The directory to run the command in
1576
:keyword error_regexes: A list of expected error messages. If
1577
specified they must be seen in the error output of the command.
1579
out, err = self._run_bzr_autosplit(
1584
working_dir=working_dir,
1586
for regex in error_regexes:
1587
self.assertContainsRe(err, regex)
1590
def run_bzr_error(self, error_regexes, *args, **kwargs):
1591
"""Run bzr, and check that stderr contains the supplied regexes
1593
:param error_regexes: Sequence of regular expressions which
1594
must each be found in the error output. The relative ordering
1596
:param args: command-line arguments for bzr
1597
:param kwargs: Keyword arguments which are interpreted by run_bzr
1598
This function changes the default value of retcode to be 3,
1599
since in most cases this is run when you expect bzr to fail.
1601
:return: (out, err) The actual output of running the command (in case
1602
you want to do more inspection)
1606
# Make sure that commit is failing because there is nothing to do
1607
self.run_bzr_error(['no changes to commit'],
1608
['commit', '-m', 'my commit comment'])
1609
# Make sure --strict is handling an unknown file, rather than
1610
# giving us the 'nothing to do' error
1611
self.build_tree(['unknown'])
1612
self.run_bzr_error(['Commit refused because there are unknown files'],
1613
['commit', --strict', '-m', 'my commit comment'])
1615
kwargs.setdefault('retcode', 3)
1616
kwargs['error_regexes'] = error_regexes
1617
out, err = self.run_bzr(*args, **kwargs)
1620
def run_bzr_subprocess(self, *args, **kwargs):
1621
"""Run bzr in a subprocess for testing.
1623
This starts a new Python interpreter and runs bzr in there.
1624
This should only be used for tests that have a justifiable need for
1625
this isolation: e.g. they are testing startup time, or signal
1626
handling, or early startup code, etc. Subprocess code can't be
1627
profiled or debugged so easily.
1629
:keyword retcode: The status code that is expected. Defaults to 0. If
1630
None is supplied, the status code is not checked.
1631
:keyword env_changes: A dictionary which lists changes to environment
1632
variables. A value of None will unset the env variable.
1633
The values must be strings. The change will only occur in the
1634
child, so you don't need to fix the environment after running.
1635
:keyword universal_newlines: Convert CRLF => LF
1636
:keyword allow_plugins: By default the subprocess is run with
1637
--no-plugins to ensure test reproducibility. Also, it is possible
1638
for system-wide plugins to create unexpected output on stderr,
1639
which can cause unnecessary test failures.
1641
env_changes = kwargs.get('env_changes', {})
1642
working_dir = kwargs.get('working_dir', None)
1643
allow_plugins = kwargs.get('allow_plugins', False)
1645
if isinstance(args[0], list):
1647
elif isinstance(args[0], basestring):
1648
args = list(shlex.split(args[0]))
1650
raise ValueError("passing varargs to run_bzr_subprocess")
1651
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1652
working_dir=working_dir,
1653
allow_plugins=allow_plugins)
1654
# We distinguish between retcode=None and retcode not passed.
1655
supplied_retcode = kwargs.get('retcode', 0)
1656
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1657
universal_newlines=kwargs.get('universal_newlines', False),
1660
def start_bzr_subprocess(self, process_args, env_changes=None,
1661
skip_if_plan_to_signal=False,
1663
allow_plugins=False):
1664
"""Start bzr in a subprocess for testing.
1666
This starts a new Python interpreter and runs bzr in there.
1667
This should only be used for tests that have a justifiable need for
1668
this isolation: e.g. they are testing startup time, or signal
1669
handling, or early startup code, etc. Subprocess code can't be
1670
profiled or debugged so easily.
1672
:param process_args: a list of arguments to pass to the bzr executable,
1673
for example ``['--version']``.
1674
:param env_changes: A dictionary which lists changes to environment
1675
variables. A value of None will unset the env variable.
1676
The values must be strings. The change will only occur in the
1677
child, so you don't need to fix the environment after running.
1678
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1680
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1682
:returns: Popen object for the started process.
1684
if skip_if_plan_to_signal:
1685
if not getattr(os, 'kill', None):
1686
raise TestSkipped("os.kill not available.")
1688
if env_changes is None:
1692
def cleanup_environment():
1693
for env_var, value in env_changes.iteritems():
1694
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1696
def restore_environment():
1697
for env_var, value in old_env.iteritems():
1698
osutils.set_or_unset_env(env_var, value)
1700
bzr_path = self.get_bzr_path()
1703
if working_dir is not None:
1704
cwd = osutils.getcwd()
1705
os.chdir(working_dir)
1708
# win32 subprocess doesn't support preexec_fn
1709
# so we will avoid using it on all platforms, just to
1710
# make sure the code path is used, and we don't break on win32
1711
cleanup_environment()
1712
command = [sys.executable]
1713
# frozen executables don't need the path to bzr
1714
if getattr(sys, "frozen", None) is None:
1715
command.append(bzr_path)
1716
if not allow_plugins:
1717
command.append('--no-plugins')
1718
command.extend(process_args)
1719
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1721
restore_environment()
1727
def _popen(self, *args, **kwargs):
1728
"""Place a call to Popen.
1730
Allows tests to override this method to intercept the calls made to
1731
Popen for introspection.
1733
return Popen(*args, **kwargs)
1735
def get_bzr_path(self):
1736
"""Return the path of the 'bzr' executable for this test suite."""
1737
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1738
if not os.path.isfile(bzr_path):
1739
# We are probably installed. Assume sys.argv is the right file
1740
bzr_path = sys.argv[0]
1743
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1744
universal_newlines=False, process_args=None):
1745
"""Finish the execution of process.
1747
:param process: the Popen object returned from start_bzr_subprocess.
1748
:param retcode: The status code that is expected. Defaults to 0. If
1749
None is supplied, the status code is not checked.
1750
:param send_signal: an optional signal to send to the process.
1751
:param universal_newlines: Convert CRLF => LF
1752
:returns: (stdout, stderr)
1754
if send_signal is not None:
1755
os.kill(process.pid, send_signal)
1756
out, err = process.communicate()
1758
if universal_newlines:
1759
out = out.replace('\r\n', '\n')
1760
err = err.replace('\r\n', '\n')
1762
if retcode is not None and retcode != process.returncode:
1763
if process_args is None:
1764
process_args = "(unknown args)"
1765
mutter('Output of bzr %s:\n%s', process_args, out)
1766
mutter('Error for bzr %s:\n%s', process_args, err)
1767
self.fail('Command bzr %s failed with retcode %s != %s'
1768
% (process_args, retcode, process.returncode))
1771
def check_inventory_shape(self, inv, shape):
1772
"""Compare an inventory to a list of expected names.
1774
Fail if they are not precisely equal.
1777
shape = list(shape) # copy
1778
for path, ie in inv.entries():
1779
name = path.replace('\\', '/')
1780
if ie.kind == 'directory':
1787
self.fail("expected paths not found in inventory: %r" % shape)
1789
self.fail("unexpected paths found in inventory: %r" % extras)
1791
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1792
a_callable=None, *args, **kwargs):
1793
"""Call callable with redirected std io pipes.
1795
Returns the return code."""
1796
if not callable(a_callable):
1797
raise ValueError("a_callable must be callable.")
1799
stdin = StringIO("")
1801
if getattr(self, "_log_file", None) is not None:
1802
stdout = self._log_file
1806
if getattr(self, "_log_file", None is not None):
1807
stderr = self._log_file
1810
real_stdin = sys.stdin
1811
real_stdout = sys.stdout
1812
real_stderr = sys.stderr
1817
return a_callable(*args, **kwargs)
1819
sys.stdout = real_stdout
1820
sys.stderr = real_stderr
1821
sys.stdin = real_stdin
1823
def reduceLockdirTimeout(self):
1824
"""Reduce the default lock timeout for the duration of the test, so that
1825
if LockContention occurs during a test, it does so quickly.
1827
Tests that expect to provoke LockContention errors should call this.
1829
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1831
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1832
self.addCleanup(resetTimeout)
1833
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1835
def make_utf8_encoded_stringio(self, encoding_type=None):
1836
"""Return a StringIOWrapper instance, that will encode Unicode
1839
if encoding_type is None:
1840
encoding_type = 'strict'
1842
output_encoding = 'utf-8'
1843
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1844
sio.encoding = output_encoding
1848
class CapturedCall(object):
1849
"""A helper for capturing smart server calls for easy debug analysis."""
1851
def __init__(self, params, prefix_length):
1852
"""Capture the call with params and skip prefix_length stack frames."""
1855
# The last 5 frames are the __init__, the hook frame, and 3 smart
1856
# client frames. Beyond this we could get more clever, but this is good
1858
stack = traceback.extract_stack()[prefix_length:-5]
1859
self.stack = ''.join(traceback.format_list(stack))
1862
return self.call.method
1865
return self.call.method
1871
class TestCaseWithMemoryTransport(TestCase):
1872
"""Common test class for tests that do not need disk resources.
1874
Tests that need disk resources should derive from TestCaseWithTransport.
1876
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1878
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1879
a directory which does not exist. This serves to help ensure test isolation
1880
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1881
must exist. However, TestCaseWithMemoryTransport does not offer local
1882
file defaults for the transport in tests, nor does it obey the command line
1883
override, so tests that accidentally write to the common directory should
1886
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1887
a .bzr directory that stops us ascending higher into the filesystem.
1893
def __init__(self, methodName='runTest'):
1894
# allow test parameterization after test construction and before test
1895
# execution. Variables that the parameterizer sets need to be
1896
# ones that are not set by setUp, or setUp will trash them.
1897
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1898
self.vfs_transport_factory = default_transport
1899
self.transport_server = None
1900
self.transport_readonly_server = None
1901
self.__vfs_server = None
1903
def get_transport(self, relpath=None):
1904
"""Return a writeable transport.
1906
This transport is for the test scratch space relative to
1909
:param relpath: a path relative to the base url.
1911
t = get_transport(self.get_url(relpath))
1912
self.assertFalse(t.is_readonly())
1915
def get_readonly_transport(self, relpath=None):
1916
"""Return a readonly transport for the test scratch space
1918
This can be used to test that operations which should only need
1919
readonly access in fact do not try to write.
1921
:param relpath: a path relative to the base url.
1923
t = get_transport(self.get_readonly_url(relpath))
1924
self.assertTrue(t.is_readonly())
1927
def create_transport_readonly_server(self):
1928
"""Create a transport server from class defined at init.
1930
This is mostly a hook for daughter classes.
1932
return self.transport_readonly_server()
1934
def get_readonly_server(self):
1935
"""Get the server instance for the readonly transport
1937
This is useful for some tests with specific servers to do diagnostics.
1939
if self.__readonly_server is None:
1940
if self.transport_readonly_server is None:
1941
# readonly decorator requested
1942
# bring up the server
1943
self.__readonly_server = ReadonlyServer()
1944
self.__readonly_server.setUp(self.get_vfs_only_server())
1946
self.__readonly_server = self.create_transport_readonly_server()
1947
self.__readonly_server.setUp(self.get_vfs_only_server())
1948
self.addCleanup(self.__readonly_server.tearDown)
1949
return self.__readonly_server
1951
def get_readonly_url(self, relpath=None):
1952
"""Get a URL for the readonly transport.
1954
This will either be backed by '.' or a decorator to the transport
1955
used by self.get_url()
1956
relpath provides for clients to get a path relative to the base url.
1957
These should only be downwards relative, not upwards.
1959
base = self.get_readonly_server().get_url()
1960
return self._adjust_url(base, relpath)
1962
def get_vfs_only_server(self):
1963
"""Get the vfs only read/write server instance.
1965
This is useful for some tests with specific servers that need
1968
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1969
is no means to override it.
1971
if self.__vfs_server is None:
1972
self.__vfs_server = MemoryServer()
1973
self.__vfs_server.setUp()
1974
self.addCleanup(self.__vfs_server.tearDown)
1975
return self.__vfs_server
1977
def get_server(self):
1978
"""Get the read/write server instance.
1980
This is useful for some tests with specific servers that need
1983
This is built from the self.transport_server factory. If that is None,
1984
then the self.get_vfs_server is returned.
1986
if self.__server is None:
1987
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1988
return self.get_vfs_only_server()
1990
# bring up a decorated means of access to the vfs only server.
1991
self.__server = self.transport_server()
1993
self.__server.setUp(self.get_vfs_only_server())
1994
except TypeError, e:
1995
# This should never happen; the try:Except here is to assist
1996
# developers having to update code rather than seeing an
1997
# uninformative TypeError.
1998
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1999
self.addCleanup(self.__server.tearDown)
2000
return self.__server
2002
def _adjust_url(self, base, relpath):
2003
"""Get a URL (or maybe a path) for the readwrite transport.
2005
This will either be backed by '.' or to an equivalent non-file based
2007
relpath provides for clients to get a path relative to the base url.
2008
These should only be downwards relative, not upwards.
2010
if relpath is not None and relpath != '.':
2011
if not base.endswith('/'):
2013
# XXX: Really base should be a url; we did after all call
2014
# get_url()! But sometimes it's just a path (from
2015
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2016
# to a non-escaped local path.
2017
if base.startswith('./') or base.startswith('/'):
2020
base += urlutils.escape(relpath)
2023
def get_url(self, relpath=None):
2024
"""Get a URL (or maybe a path) for the readwrite transport.
2026
This will either be backed by '.' or to an equivalent non-file based
2028
relpath provides for clients to get a path relative to the base url.
2029
These should only be downwards relative, not upwards.
2031
base = self.get_server().get_url()
2032
return self._adjust_url(base, relpath)
2034
def get_vfs_only_url(self, relpath=None):
2035
"""Get a URL (or maybe a path for the plain old vfs transport.
2037
This will never be a smart protocol. It always has all the
2038
capabilities of the local filesystem, but it might actually be a
2039
MemoryTransport or some other similar virtual filesystem.
2041
This is the backing transport (if any) of the server returned by
2042
get_url and get_readonly_url.
2044
:param relpath: provides for clients to get a path relative to the base
2045
url. These should only be downwards relative, not upwards.
2048
base = self.get_vfs_only_server().get_url()
2049
return self._adjust_url(base, relpath)
2051
def _create_safety_net(self):
2052
"""Make a fake bzr directory.
2054
This prevents any tests propagating up onto the TEST_ROOT directory's
2057
root = TestCaseWithMemoryTransport.TEST_ROOT
2058
bzrdir.BzrDir.create_standalone_workingtree(root)
2060
def _check_safety_net(self):
2061
"""Check that the safety .bzr directory have not been touched.
2063
_make_test_root have created a .bzr directory to prevent tests from
2064
propagating. This method ensures than a test did not leaked.
2066
root = TestCaseWithMemoryTransport.TEST_ROOT
2067
wt = workingtree.WorkingTree.open(root)
2068
last_rev = wt.last_revision()
2069
if last_rev != 'null:':
2070
# The current test have modified the /bzr directory, we need to
2071
# recreate a new one or all the followng tests will fail.
2072
# If you need to inspect its content uncomment the following line
2073
# import pdb; pdb.set_trace()
2074
_rmtree_temp_dir(root + '/.bzr')
2075
self._create_safety_net()
2076
raise AssertionError('%s/.bzr should not be modified' % root)
2078
def _make_test_root(self):
2079
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2080
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2081
TestCaseWithMemoryTransport.TEST_ROOT = root
2083
self._create_safety_net()
2085
# The same directory is used by all tests, and we're not
2086
# specifically told when all tests are finished. This will do.
2087
atexit.register(_rmtree_temp_dir, root)
2089
self.addCleanup(self._check_safety_net)
2091
def makeAndChdirToTestDir(self):
2092
"""Create a temporary directories for this one test.
2094
This must set self.test_home_dir and self.test_dir and chdir to
2097
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2099
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2100
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2101
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2103
def make_branch(self, relpath, format=None):
2104
"""Create a branch on the transport at relpath."""
2105
repo = self.make_repository(relpath, format=format)
2106
return repo.bzrdir.create_branch()
2108
def make_bzrdir(self, relpath, format=None):
2110
# might be a relative or absolute path
2111
maybe_a_url = self.get_url(relpath)
2112
segments = maybe_a_url.rsplit('/', 1)
2113
t = get_transport(maybe_a_url)
2114
if len(segments) > 1 and segments[-1] not in ('', '.'):
2118
if isinstance(format, basestring):
2119
format = bzrdir.format_registry.make_bzrdir(format)
2120
return format.initialize_on_transport(t)
2121
except errors.UninitializableFormat:
2122
raise TestSkipped("Format %s is not initializable." % format)
2124
def make_repository(self, relpath, shared=False, format=None):
2125
"""Create a repository on our default transport at relpath.
2127
Note that relpath must be a relative path, not a full url.
2129
# FIXME: If you create a remoterepository this returns the underlying
2130
# real format, which is incorrect. Actually we should make sure that
2131
# RemoteBzrDir returns a RemoteRepository.
2132
# maybe mbp 20070410
2133
made_control = self.make_bzrdir(relpath, format=format)
2134
return made_control.create_repository(shared=shared)
2136
def make_smart_server(self, path):
2137
smart_server = server.SmartTCPServer_for_testing()
2138
smart_server.setUp(self.get_server())
2139
remote_transport = get_transport(smart_server.get_url()).clone(path)
2140
self.addCleanup(smart_server.tearDown)
2141
return remote_transport
2143
def make_branch_and_memory_tree(self, relpath, format=None):
2144
"""Create a branch on the default transport and a MemoryTree for it."""
2145
b = self.make_branch(relpath, format=format)
2146
return memorytree.MemoryTree.create_on_branch(b)
2148
def make_branch_builder(self, relpath, format=None):
2149
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2152
def overrideEnvironmentForTesting(self):
2153
os.environ['HOME'] = self.test_home_dir
2154
os.environ['BZR_HOME'] = self.test_home_dir
2157
super(TestCaseWithMemoryTransport, self).setUp()
2158
self._make_test_root()
2159
_currentdir = os.getcwdu()
2160
def _leaveDirectory():
2161
os.chdir(_currentdir)
2162
self.addCleanup(_leaveDirectory)
2163
self.makeAndChdirToTestDir()
2164
self.overrideEnvironmentForTesting()
2165
self.__readonly_server = None
2166
self.__server = None
2167
self.reduceLockdirTimeout()
2169
def setup_smart_server_with_call_log(self):
2170
"""Sets up a smart server as the transport server with a call log."""
2171
self.transport_server = server.SmartTCPServer_for_testing
2172
self.hpss_calls = []
2174
# Skip the current stack down to the caller of
2175
# setup_smart_server_with_call_log
2176
prefix_length = len(traceback.extract_stack()) - 2
2177
def capture_hpss_call(params):
2178
self.hpss_calls.append(
2179
CapturedCall(params, prefix_length))
2180
client._SmartClient.hooks.install_named_hook(
2181
'call', capture_hpss_call, None)
2183
def reset_smart_call_log(self):
2184
self.hpss_calls = []
2187
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2188
"""Derived class that runs a test within a temporary directory.
2190
This is useful for tests that need to create a branch, etc.
2192
The directory is created in a slightly complex way: for each
2193
Python invocation, a new temporary top-level directory is created.
2194
All test cases create their own directory within that. If the
2195
tests complete successfully, the directory is removed.
2197
:ivar test_base_dir: The path of the top-level directory for this
2198
test, which contains a home directory and a work directory.
2200
:ivar test_home_dir: An initially empty directory under test_base_dir
2201
which is used as $HOME for this test.
2203
:ivar test_dir: A directory under test_base_dir used as the current
2204
directory when the test proper is run.
2207
OVERRIDE_PYTHON = 'python'
2209
def check_file_contents(self, filename, expect):
2210
self.log("check contents of file %s" % filename)
2211
contents = file(filename, 'r').read()
2212
if contents != expect:
2213
self.log("expected: %r" % expect)
2214
self.log("actually: %r" % contents)
2215
self.fail("contents of %s not as expected" % filename)
2217
def _getTestDirPrefix(self):
2218
# create a directory within the top level test directory
2219
if sys.platform == 'win32':
2220
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2221
# windows is likely to have path-length limits so use a short name
2222
name_prefix = name_prefix[-30:]
2224
name_prefix = re.sub('[/]', '_', self.id())
2227
def makeAndChdirToTestDir(self):
2228
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2230
For TestCaseInTempDir we create a temporary directory based on the test
2231
name and then create two subdirs - test and home under it.
2233
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2234
self._getTestDirPrefix())
2236
for i in range(100):
2237
if os.path.exists(name):
2238
name = name_prefix + '_' + str(i)
2242
# now create test and home directories within this dir
2243
self.test_base_dir = name
2244
self.test_home_dir = self.test_base_dir + '/home'
2245
os.mkdir(self.test_home_dir)
2246
self.test_dir = self.test_base_dir + '/work'
2247
os.mkdir(self.test_dir)
2248
os.chdir(self.test_dir)
2249
# put name of test inside
2250
f = file(self.test_base_dir + '/name', 'w')
2255
self.addCleanup(self.deleteTestDir)
2257
def deleteTestDir(self):
2258
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2259
_rmtree_temp_dir(self.test_base_dir)
2261
def build_tree(self, shape, line_endings='binary', transport=None):
2262
"""Build a test tree according to a pattern.
2264
shape is a sequence of file specifications. If the final
2265
character is '/', a directory is created.
2267
This assumes that all the elements in the tree being built are new.
2269
This doesn't add anything to a branch.
2271
:type shape: list or tuple.
2272
:param line_endings: Either 'binary' or 'native'
2273
in binary mode, exact contents are written in native mode, the
2274
line endings match the default platform endings.
2275
:param transport: A transport to write to, for building trees on VFS's.
2276
If the transport is readonly or None, "." is opened automatically.
2279
if type(shape) not in (list, tuple):
2280
raise AssertionError("Parameter 'shape' should be "
2281
"a list or a tuple. Got %r instead" % (shape,))
2282
# It's OK to just create them using forward slashes on windows.
2283
if transport is None or transport.is_readonly():
2284
transport = get_transport(".")
2286
self.assertIsInstance(name, basestring)
2288
transport.mkdir(urlutils.escape(name[:-1]))
2290
if line_endings == 'binary':
2292
elif line_endings == 'native':
2295
raise errors.BzrError(
2296
'Invalid line ending request %r' % line_endings)
2297
content = "contents of %s%s" % (name.encode('utf-8'), end)
2298
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2300
def build_tree_contents(self, shape):
2301
build_tree_contents(shape)
2303
def assertInWorkingTree(self, path, root_path='.', tree=None):
2304
"""Assert whether path or paths are in the WorkingTree"""
2306
tree = workingtree.WorkingTree.open(root_path)
2307
if not isinstance(path, basestring):
2309
self.assertInWorkingTree(p, tree=tree)
2311
self.assertIsNot(tree.path2id(path), None,
2312
path+' not in working tree.')
2314
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2315
"""Assert whether path or paths are not in the WorkingTree"""
2317
tree = workingtree.WorkingTree.open(root_path)
2318
if not isinstance(path, basestring):
2320
self.assertNotInWorkingTree(p,tree=tree)
2322
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2325
class TestCaseWithTransport(TestCaseInTempDir):
2326
"""A test case that provides get_url and get_readonly_url facilities.
2328
These back onto two transport servers, one for readonly access and one for
2331
If no explicit class is provided for readonly access, a
2332
ReadonlyTransportDecorator is used instead which allows the use of non disk
2333
based read write transports.
2335
If an explicit class is provided for readonly access, that server and the
2336
readwrite one must both define get_url() as resolving to os.getcwd().
2339
def get_vfs_only_server(self):
2340
"""See TestCaseWithMemoryTransport.
2342
This is useful for some tests with specific servers that need
2345
if self.__vfs_server is None:
2346
self.__vfs_server = self.vfs_transport_factory()
2347
self.__vfs_server.setUp()
2348
self.addCleanup(self.__vfs_server.tearDown)
2349
return self.__vfs_server
2351
def make_branch_and_tree(self, relpath, format=None):
2352
"""Create a branch on the transport and a tree locally.
2354
If the transport is not a LocalTransport, the Tree can't be created on
2355
the transport. In that case if the vfs_transport_factory is
2356
LocalURLServer the working tree is created in the local
2357
directory backing the transport, and the returned tree's branch and
2358
repository will also be accessed locally. Otherwise a lightweight
2359
checkout is created and returned.
2361
:param format: The BzrDirFormat.
2362
:returns: the WorkingTree.
2364
# TODO: always use the local disk path for the working tree,
2365
# this obviously requires a format that supports branch references
2366
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2368
b = self.make_branch(relpath, format=format)
2370
return b.bzrdir.create_workingtree()
2371
except errors.NotLocalUrl:
2372
# We can only make working trees locally at the moment. If the
2373
# transport can't support them, then we keep the non-disk-backed
2374
# branch and create a local checkout.
2375
if self.vfs_transport_factory is LocalURLServer:
2376
# the branch is colocated on disk, we cannot create a checkout.
2377
# hopefully callers will expect this.
2378
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2379
wt = local_controldir.create_workingtree()
2380
if wt.branch._format != b._format:
2382
# Make sure that assigning to wt._branch fixes wt.branch,
2383
# in case the implementation details of workingtree objects
2385
self.assertIs(b, wt.branch)
2388
return b.create_checkout(relpath, lightweight=True)
2390
def assertIsDirectory(self, relpath, transport):
2391
"""Assert that relpath within transport is a directory.
2393
This may not be possible on all transports; in that case it propagates
2394
a TransportNotPossible.
2397
mode = transport.stat(relpath).st_mode
2398
except errors.NoSuchFile:
2399
self.fail("path %s is not a directory; no such file"
2401
if not stat.S_ISDIR(mode):
2402
self.fail("path %s is not a directory; has mode %#o"
2405
def assertTreesEqual(self, left, right):
2406
"""Check that left and right have the same content and properties."""
2407
# we use a tree delta to check for equality of the content, and we
2408
# manually check for equality of other things such as the parents list.
2409
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2410
differences = left.changes_from(right)
2411
self.assertFalse(differences.has_changed(),
2412
"Trees %r and %r are different: %r" % (left, right, differences))
2415
super(TestCaseWithTransport, self).setUp()
2416
self.__vfs_server = None
2419
class ChrootedTestCase(TestCaseWithTransport):
2420
"""A support class that provides readonly urls outside the local namespace.
2422
This is done by checking if self.transport_server is a MemoryServer. if it
2423
is then we are chrooted already, if it is not then an HttpServer is used
2426
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2427
be used without needed to redo it when a different
2428
subclass is in use ?
2432
super(ChrootedTestCase, self).setUp()
2433
if not self.vfs_transport_factory == MemoryServer:
2434
self.transport_readonly_server = HttpServer
2437
def condition_id_re(pattern):
2438
"""Create a condition filter which performs a re check on a test's id.
2440
:param pattern: A regular expression string.
2441
:return: A callable that returns True if the re matches.
2443
filter_re = osutils.re_compile_checked(pattern, 0,
2445
def condition(test):
2447
return filter_re.search(test_id)
2451
def condition_isinstance(klass_or_klass_list):
2452
"""Create a condition filter which returns isinstance(param, klass).
2454
:return: A callable which when called with one parameter obj return the
2455
result of isinstance(obj, klass_or_klass_list).
2458
return isinstance(obj, klass_or_klass_list)
2462
def condition_id_in_list(id_list):
2463
"""Create a condition filter which verify that test's id in a list.
2465
:param id_list: A TestIdList object.
2466
:return: A callable that returns True if the test's id appears in the list.
2468
def condition(test):
2469
return id_list.includes(test.id())
2473
def condition_id_startswith(starts):
2474
"""Create a condition filter verifying that test's id starts with a string.
2476
:param starts: A list of string.
2477
:return: A callable that returns True if the test's id starts with one of
2480
def condition(test):
2481
for start in starts:
2482
if test.id().startswith(start):
2488
def exclude_tests_by_condition(suite, condition):
2489
"""Create a test suite which excludes some tests from suite.
2491
:param suite: The suite to get tests from.
2492
:param condition: A callable whose result evaluates True when called with a
2493
test case which should be excluded from the result.
2494
:return: A suite which contains the tests found in suite that fail
2498
for test in iter_suite_tests(suite):
2499
if not condition(test):
2501
return TestUtil.TestSuite(result)
2504
def filter_suite_by_condition(suite, condition):
2505
"""Create a test suite by filtering another one.
2507
:param suite: The source suite.
2508
:param condition: A callable whose result evaluates True when called with a
2509
test case which should be included in the result.
2510
:return: A suite which contains the tests found in suite that pass
2514
for test in iter_suite_tests(suite):
2517
return TestUtil.TestSuite(result)
2520
def filter_suite_by_re(suite, pattern):
2521
"""Create a test suite by filtering another one.
2523
:param suite: the source suite
2524
:param pattern: pattern that names must match
2525
:returns: the newly created suite
2527
condition = condition_id_re(pattern)
2528
result_suite = filter_suite_by_condition(suite, condition)
2532
def filter_suite_by_id_list(suite, test_id_list):
2533
"""Create a test suite by filtering another one.
2535
:param suite: The source suite.
2536
:param test_id_list: A list of the test ids to keep as strings.
2537
:returns: the newly created suite
2539
condition = condition_id_in_list(test_id_list)
2540
result_suite = filter_suite_by_condition(suite, condition)
2544
def filter_suite_by_id_startswith(suite, start):
2545
"""Create a test suite by filtering another one.
2547
:param suite: The source suite.
2548
:param start: A list of string the test id must start with one of.
2549
:returns: the newly created suite
2551
condition = condition_id_startswith(start)
2552
result_suite = filter_suite_by_condition(suite, condition)
2556
def exclude_tests_by_re(suite, pattern):
2557
"""Create a test suite which excludes some tests from suite.
2559
:param suite: The suite to get tests from.
2560
:param pattern: A regular expression string. Test ids that match this
2561
pattern will be excluded from the result.
2562
:return: A TestSuite that contains all the tests from suite without the
2563
tests that matched pattern. The order of tests is the same as it was in
2566
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2569
def preserve_input(something):
2570
"""A helper for performing test suite transformation chains.
2572
:param something: Anything you want to preserve.
2578
def randomize_suite(suite):
2579
"""Return a new TestSuite with suite's tests in random order.
2581
The tests in the input suite are flattened into a single suite in order to
2582
accomplish this. Any nested TestSuites are removed to provide global
2585
tests = list(iter_suite_tests(suite))
2586
random.shuffle(tests)
2587
return TestUtil.TestSuite(tests)
2590
def split_suite_by_condition(suite, condition):
2591
"""Split a test suite into two by a condition.
2593
:param suite: The suite to split.
2594
:param condition: The condition to match on. Tests that match this
2595
condition are returned in the first test suite, ones that do not match
2596
are in the second suite.
2597
:return: A tuple of two test suites, where the first contains tests from
2598
suite matching the condition, and the second contains the remainder
2599
from suite. The order within each output suite is the same as it was in
2604
for test in iter_suite_tests(suite):
2606
matched.append(test)
2608
did_not_match.append(test)
2609
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2612
def split_suite_by_re(suite, pattern):
2613
"""Split a test suite into two by a regular expression.
2615
:param suite: The suite to split.
2616
:param pattern: A regular expression string. Test ids that match this
2617
pattern will be in the first test suite returned, and the others in the
2618
second test suite returned.
2619
:return: A tuple of two test suites, where the first contains tests from
2620
suite matching pattern, and the second contains the remainder from
2621
suite. The order within each output suite is the same as it was in
2624
return split_suite_by_condition(suite, condition_id_re(pattern))
2627
def run_suite(suite, name='test', verbose=False, pattern=".*",
2628
stop_on_failure=False,
2629
transport=None, lsprof_timed=None, bench_history=None,
2630
matching_tests_first=None,
2633
exclude_pattern=None,
2636
suite_decorators=None):
2637
"""Run a test suite for bzr selftest.
2639
:param runner_class: The class of runner to use. Must support the
2640
constructor arguments passed by run_suite which are more than standard
2642
:return: A boolean indicating success.
2644
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2649
if runner_class is None:
2650
runner_class = TextTestRunner
2651
runner = runner_class(stream=sys.stdout,
2653
verbosity=verbosity,
2654
bench_history=bench_history,
2655
list_only=list_only,
2657
runner.stop_on_failure=stop_on_failure
2658
# built in decorator factories:
2660
random_order(random_seed, runner),
2661
exclude_tests(exclude_pattern),
2663
if matching_tests_first:
2664
decorators.append(tests_first(pattern))
2666
decorators.append(filter_tests(pattern))
2667
if suite_decorators:
2668
decorators.extend(suite_decorators)
2669
for decorator in decorators:
2670
suite = decorator(suite)
2671
result = runner.run(suite)
2673
return result.wasStrictlySuccessful()
2675
return result.wasSuccessful()
2678
# A registry where get() returns a suite decorator.
2679
parallel_registry = registry.Registry()
2682
def fork_decorator(suite):
2683
concurrency = local_concurrency()
2684
if concurrency == 1:
2686
from testtools import ConcurrentTestSuite
2687
return ConcurrentTestSuite(suite, fork_for_tests)
2688
parallel_registry.register('fork', fork_decorator)
2691
def subprocess_decorator(suite):
2692
concurrency = local_concurrency()
2693
if concurrency == 1:
2695
from testtools import ConcurrentTestSuite
2696
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2697
parallel_registry.register('subprocess', subprocess_decorator)
2700
def exclude_tests(exclude_pattern):
2701
"""Return a test suite decorator that excludes tests."""
2702
if exclude_pattern is None:
2703
return identity_decorator
2704
def decorator(suite):
2705
return ExcludeDecorator(suite, exclude_pattern)
2709
def filter_tests(pattern):
2711
return identity_decorator
2712
def decorator(suite):
2713
return FilterTestsDecorator(suite, pattern)
2717
def random_order(random_seed, runner):
2718
"""Return a test suite decorator factory for randomising tests order.
2720
:param random_seed: now, a string which casts to a long, or a long.
2721
:param runner: A test runner with a stream attribute to report on.
2723
if random_seed is None:
2724
return identity_decorator
2725
def decorator(suite):
2726
return RandomDecorator(suite, random_seed, runner.stream)
2730
def tests_first(pattern):
2732
return identity_decorator
2733
def decorator(suite):
2734
return TestFirstDecorator(suite, pattern)
2738
def identity_decorator(suite):
2743
class TestDecorator(TestSuite):
2744
"""A decorator for TestCase/TestSuite objects.
2746
Usually, subclasses should override __iter__(used when flattening test
2747
suites), which we do to filter, reorder, parallelise and so on, run() and
2751
def __init__(self, suite):
2752
TestSuite.__init__(self)
2755
def countTestCases(self):
2758
cases += test.countTestCases()
2765
def run(self, result):
2766
# Use iteration on self, not self._tests, to allow subclasses to hook
2769
if result.shouldStop:
2775
class ExcludeDecorator(TestDecorator):
2776
"""A decorator which excludes test matching an exclude pattern."""
2778
def __init__(self, suite, exclude_pattern):
2779
TestDecorator.__init__(self, suite)
2780
self.exclude_pattern = exclude_pattern
2781
self.excluded = False
2785
return iter(self._tests)
2786
self.excluded = True
2787
suite = exclude_tests_by_re(self, self.exclude_pattern)
2789
self.addTests(suite)
2790
return iter(self._tests)
2793
class FilterTestsDecorator(TestDecorator):
2794
"""A decorator which filters tests to those matching a pattern."""
2796
def __init__(self, suite, pattern):
2797
TestDecorator.__init__(self, suite)
2798
self.pattern = pattern
2799
self.filtered = False
2803
return iter(self._tests)
2804
self.filtered = True
2805
suite = filter_suite_by_re(self, self.pattern)
2807
self.addTests(suite)
2808
return iter(self._tests)
2811
class RandomDecorator(TestDecorator):
2812
"""A decorator which randomises the order of its tests."""
2814
def __init__(self, suite, random_seed, stream):
2815
TestDecorator.__init__(self, suite)
2816
self.random_seed = random_seed
2817
self.randomised = False
2818
self.stream = stream
2822
return iter(self._tests)
2823
self.randomised = True
2824
self.stream.writeln("Randomizing test order using seed %s\n" %
2825
(self.actual_seed()))
2826
# Initialise the random number generator.
2827
random.seed(self.actual_seed())
2828
suite = randomize_suite(self)
2830
self.addTests(suite)
2831
return iter(self._tests)
2833
def actual_seed(self):
2834
if self.random_seed == "now":
2835
# We convert the seed to a long to make it reuseable across
2836
# invocations (because the user can reenter it).
2837
self.random_seed = long(time.time())
2839
# Convert the seed to a long if we can
2841
self.random_seed = long(self.random_seed)
2844
return self.random_seed
2847
class TestFirstDecorator(TestDecorator):
2848
"""A decorator which moves named tests to the front."""
2850
def __init__(self, suite, pattern):
2851
TestDecorator.__init__(self, suite)
2852
self.pattern = pattern
2853
self.filtered = False
2857
return iter(self._tests)
2858
self.filtered = True
2859
suites = split_suite_by_re(self, self.pattern)
2861
self.addTests(suites)
2862
return iter(self._tests)
2865
def partition_tests(suite, count):
2866
"""Partition suite into count lists of tests."""
2868
tests = list(iter_suite_tests(suite))
2869
tests_per_process = int(math.ceil(float(len(tests)) / count))
2870
for block in range(count):
2871
low_test = block * tests_per_process
2872
high_test = low_test + tests_per_process
2873
process_tests = tests[low_test:high_test]
2874
result.append(process_tests)
2878
def fork_for_tests(suite):
2879
"""Take suite and start up one runner per CPU by forking()
2881
:return: An iterable of TestCase-like objects which can each have
2882
run(result) called on them to feed tests to result.
2884
concurrency = local_concurrency()
2886
from subunit import TestProtocolClient, ProtocolTestCase
2887
class TestInOtherProcess(ProtocolTestCase):
2888
# Should be in subunit, I think. RBC.
2889
def __init__(self, stream, pid):
2890
ProtocolTestCase.__init__(self, stream)
2893
def run(self, result):
2895
ProtocolTestCase.run(self, result)
2897
os.waitpid(self.pid, os.WNOHANG)
2899
test_blocks = partition_tests(suite, concurrency)
2900
for process_tests in test_blocks:
2901
process_suite = TestSuite()
2902
process_suite.addTests(process_tests)
2903
c2pread, c2pwrite = os.pipe()
2908
# Leave stderr and stdout open so we can see test noise
2909
# Close stdin so that the child goes away if it decides to
2910
# read from stdin (otherwise its a roulette to see what
2911
# child actually gets keystrokes for pdb etc).
2914
stream = os.fdopen(c2pwrite, 'wb', 1)
2915
subunit_result = TestProtocolClient(stream)
2916
process_suite.run(subunit_result)
2921
stream = os.fdopen(c2pread, 'rb', 1)
2922
test = TestInOtherProcess(stream, pid)
2927
def reinvoke_for_tests(suite):
2928
"""Take suite and start up one runner per CPU using subprocess().
2930
:return: An iterable of TestCase-like objects which can each have
2931
run(result) called on them to feed tests to result.
2933
concurrency = local_concurrency()
2935
from subunit import TestProtocolClient, ProtocolTestCase
2936
class TestInSubprocess(ProtocolTestCase):
2937
def __init__(self, process, name):
2938
ProtocolTestCase.__init__(self, process.stdout)
2939
self.process = process
2940
self.process.stdin.close()
2943
def run(self, result):
2945
ProtocolTestCase.run(self, result)
2948
os.unlink(self.name)
2949
# print "pid %d finished" % finished_process
2950
test_blocks = partition_tests(suite, concurrency)
2951
for process_tests in test_blocks:
2952
# ugly; currently reimplement rather than reuses TestCase methods.
2953
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2954
if not os.path.isfile(bzr_path):
2955
# We are probably installed. Assume sys.argv is the right file
2956
bzr_path = sys.argv[0]
2957
fd, test_list_file_name = tempfile.mkstemp()
2958
test_list_file = os.fdopen(fd, 'wb', 1)
2959
for test in process_tests:
2960
test_list_file.write(test.id() + '\n')
2961
test_list_file.close()
2963
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
2965
if '--no-plugins' in sys.argv:
2966
argv.append('--no-plugins')
2967
# stderr=STDOUT would be ideal, but until we prevent noise on
2968
# stderr it can interrupt the subunit protocol.
2969
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
2971
test = TestInSubprocess(process, test_list_file_name)
2974
os.unlink(test_list_file_name)
2979
def cpucount(content):
2980
lines = content.splitlines()
2981
prefix = 'processor'
2983
if line.startswith(prefix):
2984
concurrency = int(line[line.find(':')+1:]) + 1
2988
def local_concurrency():
2990
content = file('/proc/cpuinfo', 'rb').read()
2991
concurrency = cpucount(content)
2992
except Exception, e:
2997
class BZRTransformingResult(unittest.TestResult):
2999
def __init__(self, target):
3000
unittest.TestResult.__init__(self)
3001
self.result = target
3003
def startTest(self, test):
3004
self.result.startTest(test)
3006
def stopTest(self, test):
3007
self.result.stopTest(test)
3009
def addError(self, test, err):
3010
feature = self._error_looks_like('UnavailableFeature: ', err)
3011
if feature is not None:
3012
self.result.addNotSupported(test, feature)
3014
self.result.addError(test, err)
3016
def addFailure(self, test, err):
3017
known = self._error_looks_like('KnownFailure: ', err)
3018
if known is not None:
3019
self.result._addKnownFailure(test, [KnownFailure,
3020
KnownFailure(known), None])
3022
self.result.addFailure(test, err)
3024
def addSkip(self, test, reason):
3025
self.result.addSkip(test, reason)
3027
def addSuccess(self, test):
3028
self.result.addSuccess(test)
3030
def _error_looks_like(self, prefix, err):
3031
"""Deserialize exception and returns the stringify value."""
3035
if isinstance(exc, subunit.RemoteException):
3036
# stringify the exception gives access to the remote traceback
3037
# We search the last line for 'prefix'
3038
lines = str(exc).split('\n')
3040
last = lines[-2] # -1 is empty, final \n
3043
if last.startswith(prefix):
3044
value = last[len(prefix):]
3048
# Controlled by "bzr selftest -E=..." option
3049
selftest_debug_flags = set()
3052
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3054
test_suite_factory=None,
3057
matching_tests_first=None,
3060
exclude_pattern=None,
3066
suite_decorators=None,
3068
"""Run the whole test suite under the enhanced runner"""
3069
# XXX: Very ugly way to do this...
3070
# Disable warning about old formats because we don't want it to disturb
3071
# any blackbox tests.
3072
from bzrlib import repository
3073
repository._deprecation_warning_done = True
3075
global default_transport
3076
if transport is None:
3077
transport = default_transport
3078
old_transport = default_transport
3079
default_transport = transport
3080
global selftest_debug_flags
3081
old_debug_flags = selftest_debug_flags
3082
if debug_flags is not None:
3083
selftest_debug_flags = set(debug_flags)
3085
if load_list is None:
3088
keep_only = load_test_id_list(load_list)
3089
if test_suite_factory is None:
3090
suite = test_suite(keep_only, starting_with)
3092
suite = test_suite_factory()
3093
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3094
stop_on_failure=stop_on_failure,
3095
transport=transport,
3096
lsprof_timed=lsprof_timed,
3097
bench_history=bench_history,
3098
matching_tests_first=matching_tests_first,
3099
list_only=list_only,
3100
random_seed=random_seed,
3101
exclude_pattern=exclude_pattern,
3103
runner_class=runner_class,
3104
suite_decorators=suite_decorators,
3107
default_transport = old_transport
3108
selftest_debug_flags = old_debug_flags
3111
def load_test_id_list(file_name):
3112
"""Load a test id list from a text file.
3114
The format is one test id by line. No special care is taken to impose
3115
strict rules, these test ids are used to filter the test suite so a test id
3116
that do not match an existing test will do no harm. This allows user to add
3117
comments, leave blank lines, etc.
3121
ftest = open(file_name, 'rt')
3123
if e.errno != errno.ENOENT:
3126
raise errors.NoSuchFile(file_name)
3128
for test_name in ftest.readlines():
3129
test_list.append(test_name.strip())
3134
def suite_matches_id_list(test_suite, id_list):
3135
"""Warns about tests not appearing or appearing more than once.
3137
:param test_suite: A TestSuite object.
3138
:param test_id_list: The list of test ids that should be found in
3141
:return: (absents, duplicates) absents is a list containing the test found
3142
in id_list but not in test_suite, duplicates is a list containing the
3143
test found multiple times in test_suite.
3145
When using a prefined test id list, it may occurs that some tests do not
3146
exist anymore or that some tests use the same id. This function warns the
3147
tester about potential problems in his workflow (test lists are volatile)
3148
or in the test suite itself (using the same id for several tests does not
3149
help to localize defects).
3151
# Build a dict counting id occurrences
3153
for test in iter_suite_tests(test_suite):
3155
tests[id] = tests.get(id, 0) + 1
3160
occurs = tests.get(id, 0)
3162
not_found.append(id)
3164
duplicates.append(id)
3166
return not_found, duplicates
3169
class TestIdList(object):
3170
"""Test id list to filter a test suite.
3172
Relying on the assumption that test ids are built as:
3173
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3174
notation, this class offers methods to :
3175
- avoid building a test suite for modules not refered to in the test list,
3176
- keep only the tests listed from the module test suite.
3179
def __init__(self, test_id_list):
3180
# When a test suite needs to be filtered against us we compare test ids
3181
# for equality, so a simple dict offers a quick and simple solution.
3182
self.tests = dict().fromkeys(test_id_list, True)
3184
# While unittest.TestCase have ids like:
3185
# <module>.<class>.<method>[(<param+)],
3186
# doctest.DocTestCase can have ids like:
3189
# <module>.<function>
3190
# <module>.<class>.<method>
3192
# Since we can't predict a test class from its name only, we settle on
3193
# a simple constraint: a test id always begins with its module name.
3196
for test_id in test_id_list:
3197
parts = test_id.split('.')
3198
mod_name = parts.pop(0)
3199
modules[mod_name] = True
3201
mod_name += '.' + part
3202
modules[mod_name] = True
3203
self.modules = modules
3205
def refers_to(self, module_name):
3206
"""Is there tests for the module or one of its sub modules."""
3207
return self.modules.has_key(module_name)
3209
def includes(self, test_id):
3210
return self.tests.has_key(test_id)
3213
class TestPrefixAliasRegistry(registry.Registry):
3214
"""A registry for test prefix aliases.
3216
This helps implement shorcuts for the --starting-with selftest
3217
option. Overriding existing prefixes is not allowed but not fatal (a
3218
warning will be emitted).
3221
def register(self, key, obj, help=None, info=None,
3222
override_existing=False):
3223
"""See Registry.register.
3225
Trying to override an existing alias causes a warning to be emitted,
3226
not a fatal execption.
3229
super(TestPrefixAliasRegistry, self).register(
3230
key, obj, help=help, info=info, override_existing=False)
3232
actual = self.get(key)
3233
note('Test prefix alias %s is already used for %s, ignoring %s'
3234
% (key, actual, obj))
3236
def resolve_alias(self, id_start):
3237
"""Replace the alias by the prefix in the given string.
3239
Using an unknown prefix is an error to help catching typos.
3241
parts = id_start.split('.')
3243
parts[0] = self.get(parts[0])
3245
raise errors.BzrCommandError(
3246
'%s is not a known test prefix alias' % parts[0])
3247
return '.'.join(parts)
3250
test_prefix_alias_registry = TestPrefixAliasRegistry()
3251
"""Registry of test prefix aliases."""
3254
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3255
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3256
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3258
# Obvious higest levels prefixes, feel free to add your own via a plugin
3259
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3260
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3261
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3262
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3263
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3266
def test_suite(keep_only=None, starting_with=None):
3267
"""Build and return TestSuite for the whole of bzrlib.
3269
:param keep_only: A list of test ids limiting the suite returned.
3271
:param starting_with: An id limiting the suite returned to the tests
3274
This function can be replaced if you need to change the default test
3275
suite on a global basis, but it is not encouraged.
3279
'bzrlib.tests.blackbox',
3280
'bzrlib.tests.branch_implementations',
3281
'bzrlib.tests.bzrdir_implementations',
3282
'bzrlib.tests.commands',
3283
'bzrlib.tests.interrepository_implementations',
3284
'bzrlib.tests.intertree_implementations',
3285
'bzrlib.tests.inventory_implementations',
3286
'bzrlib.tests.per_interbranch',
3287
'bzrlib.tests.per_lock',
3288
'bzrlib.tests.per_repository',
3289
'bzrlib.tests.per_repository_reference',
3290
'bzrlib.tests.test__dirstate_helpers',
3291
'bzrlib.tests.test__walkdirs_win32',
3292
'bzrlib.tests.test_ancestry',
3293
'bzrlib.tests.test_annotate',
3294
'bzrlib.tests.test_api',
3295
'bzrlib.tests.test_atomicfile',
3296
'bzrlib.tests.test_bad_files',
3297
'bzrlib.tests.test_bisect_multi',
3298
'bzrlib.tests.test_branch',
3299
'bzrlib.tests.test_branchbuilder',
3300
'bzrlib.tests.test_btree_index',
3301
'bzrlib.tests.test_bugtracker',
3302
'bzrlib.tests.test_bundle',
3303
'bzrlib.tests.test_bzrdir',
3304
'bzrlib.tests.test_cache_utf8',
3305
'bzrlib.tests.test_clean_tree',
3306
'bzrlib.tests.test_chunk_writer',
3307
'bzrlib.tests.test__chunks_to_lines',
3308
'bzrlib.tests.test_commands',
3309
'bzrlib.tests.test_commit',
3310
'bzrlib.tests.test_commit_merge',
3311
'bzrlib.tests.test_config',
3312
'bzrlib.tests.test_conflicts',
3313
'bzrlib.tests.test_counted_lock',
3314
'bzrlib.tests.test_decorators',
3315
'bzrlib.tests.test_delta',
3316
'bzrlib.tests.test_debug',
3317
'bzrlib.tests.test_deprecated_graph',
3318
'bzrlib.tests.test_diff',
3319
'bzrlib.tests.test_directory_service',
3320
'bzrlib.tests.test_dirstate',
3321
'bzrlib.tests.test_email_message',
3322
'bzrlib.tests.test_eol_filters',
3323
'bzrlib.tests.test_errors',
3324
'bzrlib.tests.test_export',
3325
'bzrlib.tests.test_extract',
3326
'bzrlib.tests.test_fetch',
3327
'bzrlib.tests.test_fifo_cache',
3328
'bzrlib.tests.test_filters',
3329
'bzrlib.tests.test_ftp_transport',
3330
'bzrlib.tests.test_foreign',
3331
'bzrlib.tests.test_generate_docs',
3332
'bzrlib.tests.test_generate_ids',
3333
'bzrlib.tests.test_globbing',
3334
'bzrlib.tests.test_gpg',
3335
'bzrlib.tests.test_graph',
3336
'bzrlib.tests.test_hashcache',
3337
'bzrlib.tests.test_help',
3338
'bzrlib.tests.test_hooks',
3339
'bzrlib.tests.test_http',
3340
'bzrlib.tests.test_http_implementations',
3341
'bzrlib.tests.test_http_response',
3342
'bzrlib.tests.test_https_ca_bundle',
3343
'bzrlib.tests.test_identitymap',
3344
'bzrlib.tests.test_ignores',
3345
'bzrlib.tests.test_index',
3346
'bzrlib.tests.test_info',
3347
'bzrlib.tests.test_inv',
3348
'bzrlib.tests.test_knit',
3349
'bzrlib.tests.test_lazy_import',
3350
'bzrlib.tests.test_lazy_regex',
3351
'bzrlib.tests.test_lockable_files',
3352
'bzrlib.tests.test_lockdir',
3353
'bzrlib.tests.test_log',
3354
'bzrlib.tests.test_lru_cache',
3355
'bzrlib.tests.test_lsprof',
3356
'bzrlib.tests.test_mail_client',
3357
'bzrlib.tests.test_memorytree',
3358
'bzrlib.tests.test_merge',
3359
'bzrlib.tests.test_merge3',
3360
'bzrlib.tests.test_merge_core',
3361
'bzrlib.tests.test_merge_directive',
3362
'bzrlib.tests.test_missing',
3363
'bzrlib.tests.test_msgeditor',
3364
'bzrlib.tests.test_multiparent',
3365
'bzrlib.tests.test_mutabletree',
3366
'bzrlib.tests.test_nonascii',
3367
'bzrlib.tests.test_options',
3368
'bzrlib.tests.test_osutils',
3369
'bzrlib.tests.test_osutils_encodings',
3370
'bzrlib.tests.test_pack',
3371
'bzrlib.tests.test_pack_repository',
3372
'bzrlib.tests.test_patch',
3373
'bzrlib.tests.test_patches',
3374
'bzrlib.tests.test_permissions',
3375
'bzrlib.tests.test_plugins',
3376
'bzrlib.tests.test_progress',
3377
'bzrlib.tests.test_read_bundle',
3378
'bzrlib.tests.test_reconcile',
3379
'bzrlib.tests.test_reconfigure',
3380
'bzrlib.tests.test_registry',
3381
'bzrlib.tests.test_remote',
3382
'bzrlib.tests.test_rename_map',
3383
'bzrlib.tests.test_repository',
3384
'bzrlib.tests.test_revert',
3385
'bzrlib.tests.test_revision',
3386
'bzrlib.tests.test_revisionspec',
3387
'bzrlib.tests.test_revisiontree',
3388
'bzrlib.tests.test_rio',
3389
'bzrlib.tests.test_rules',
3390
'bzrlib.tests.test_sampler',
3391
'bzrlib.tests.test_selftest',
3392
'bzrlib.tests.test_setup',
3393
'bzrlib.tests.test_sftp_transport',
3394
'bzrlib.tests.test_shelf',
3395
'bzrlib.tests.test_shelf_ui',
3396
'bzrlib.tests.test_smart',
3397
'bzrlib.tests.test_smart_add',
3398
'bzrlib.tests.test_smart_request',
3399
'bzrlib.tests.test_smart_transport',
3400
'bzrlib.tests.test_smtp_connection',
3401
'bzrlib.tests.test_source',
3402
'bzrlib.tests.test_ssh_transport',
3403
'bzrlib.tests.test_status',
3404
'bzrlib.tests.test_store',
3405
'bzrlib.tests.test_strace',
3406
'bzrlib.tests.test_subsume',
3407
'bzrlib.tests.test_switch',
3408
'bzrlib.tests.test_symbol_versioning',
3409
'bzrlib.tests.test_tag',
3410
'bzrlib.tests.test_testament',
3411
'bzrlib.tests.test_textfile',
3412
'bzrlib.tests.test_textmerge',
3413
'bzrlib.tests.test_timestamp',
3414
'bzrlib.tests.test_trace',
3415
'bzrlib.tests.test_transactions',
3416
'bzrlib.tests.test_transform',
3417
'bzrlib.tests.test_transport',
3418
'bzrlib.tests.test_transport_implementations',
3419
'bzrlib.tests.test_transport_log',
3420
'bzrlib.tests.test_tree',
3421
'bzrlib.tests.test_treebuilder',
3422
'bzrlib.tests.test_tsort',
3423
'bzrlib.tests.test_tuned_gzip',
3424
'bzrlib.tests.test_ui',
3425
'bzrlib.tests.test_uncommit',
3426
'bzrlib.tests.test_upgrade',
3427
'bzrlib.tests.test_upgrade_stacked',
3428
'bzrlib.tests.test_urlutils',
3429
'bzrlib.tests.test_version',
3430
'bzrlib.tests.test_version_info',
3431
'bzrlib.tests.test_versionedfile',
3432
'bzrlib.tests.test_weave',
3433
'bzrlib.tests.test_whitebox',
3434
'bzrlib.tests.test_win32utils',
3435
'bzrlib.tests.test_workingtree',
3436
'bzrlib.tests.test_workingtree_4',
3437
'bzrlib.tests.test_wsgi',
3438
'bzrlib.tests.test_xml',
3439
'bzrlib.tests.tree_implementations',
3440
'bzrlib.tests.workingtree_implementations',
3441
'bzrlib.util.tests.test_bencode',
3444
loader = TestUtil.TestLoader()
3447
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3448
for start in starting_with]
3449
# We take precedence over keep_only because *at loading time* using
3450
# both options means we will load less tests for the same final result.
3451
def interesting_module(name):
3452
for start in starting_with:
3454
# Either the module name starts with the specified string
3455
name.startswith(start)
3456
# or it may contain tests starting with the specified string
3457
or start.startswith(name)
3461
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3463
elif keep_only is not None:
3464
id_filter = TestIdList(keep_only)
3465
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3466
def interesting_module(name):
3467
return id_filter.refers_to(name)
3470
loader = TestUtil.TestLoader()
3471
def interesting_module(name):
3472
# No filtering, all modules are interesting
3475
suite = loader.suiteClass()
3477
# modules building their suite with loadTestsFromModuleNames
3478
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3480
modules_to_doctest = [
3482
'bzrlib.branchbuilder',
3485
'bzrlib.iterablefile',
3489
'bzrlib.symbol_versioning',
3492
'bzrlib.version_info_formats.format_custom',
3495
for mod in modules_to_doctest:
3496
if not interesting_module(mod):
3497
# No tests to keep here, move along
3500
# note that this really does mean "report only" -- doctest
3501
# still runs the rest of the examples
3502
doc_suite = doctest.DocTestSuite(mod,
3503
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3504
except ValueError, e:
3505
print '**failed to get doctest for: %s\n%s' % (mod, e)
3507
if len(doc_suite._tests) == 0:
3508
raise errors.BzrError("no doctests found in %s" % (mod,))
3509
suite.addTest(doc_suite)
3511
default_encoding = sys.getdefaultencoding()
3512
for name, plugin in bzrlib.plugin.plugins().items():
3513
if not interesting_module(plugin.module.__name__):
3515
plugin_suite = plugin.test_suite()
3516
# We used to catch ImportError here and turn it into just a warning,
3517
# but really if you don't have --no-plugins this should be a failure.
3518
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3519
if plugin_suite is None:
3520
plugin_suite = plugin.load_plugin_tests(loader)
3521
if plugin_suite is not None:
3522
suite.addTest(plugin_suite)
3523
if default_encoding != sys.getdefaultencoding():
3524
bzrlib.trace.warning(
3525
'Plugin "%s" tried to reset default encoding to: %s', name,
3526
sys.getdefaultencoding())
3528
sys.setdefaultencoding(default_encoding)
3531
suite = filter_suite_by_id_startswith(suite, starting_with)
3533
if keep_only is not None:
3534
# Now that the referred modules have loaded their tests, keep only the
3536
suite = filter_suite_by_id_list(suite, id_filter)
3537
# Do some sanity checks on the id_list filtering
3538
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3540
# The tester has used both keep_only and starting_with, so he is
3541
# already aware that some tests are excluded from the list, there
3542
# is no need to tell him which.
3545
# Some tests mentioned in the list are not in the test suite. The
3546
# list may be out of date, report to the tester.
3547
for id in not_found:
3548
bzrlib.trace.warning('"%s" not found in the test suite', id)
3549
for id in duplicates:
3550
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3555
def multiply_scenarios(scenarios_left, scenarios_right):
3556
"""Multiply two sets of scenarios.
3558
:returns: the cartesian product of the two sets of scenarios, that is
3559
a scenario for every possible combination of a left scenario and a
3563
('%s,%s' % (left_name, right_name),
3564
dict(left_dict.items() + right_dict.items()))
3565
for left_name, left_dict in scenarios_left
3566
for right_name, right_dict in scenarios_right]
3569
def multiply_tests(tests, scenarios, result):
3570
"""Multiply tests_list by scenarios into result.
3572
This is the core workhorse for test parameterisation.
3574
Typically the load_tests() method for a per-implementation test suite will
3575
call multiply_tests and return the result.
3577
:param tests: The tests to parameterise.
3578
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3579
scenario_param_dict).
3580
:param result: A TestSuite to add created tests to.
3582
This returns the passed in result TestSuite with the cross product of all
3583
the tests repeated once for each scenario. Each test is adapted by adding
3584
the scenario name at the end of its id(), and updating the test object's
3585
__dict__ with the scenario_param_dict.
3587
>>> import bzrlib.tests.test_sampler
3588
>>> r = multiply_tests(
3589
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3590
... [('one', dict(param=1)),
3591
... ('two', dict(param=2))],
3593
>>> tests = list(iter_suite_tests(r))
3597
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3603
for test in iter_suite_tests(tests):
3604
apply_scenarios(test, scenarios, result)
3608
def apply_scenarios(test, scenarios, result):
3609
"""Apply the scenarios in scenarios to test and add to result.
3611
:param test: The test to apply scenarios to.
3612
:param scenarios: An iterable of scenarios to apply to test.
3614
:seealso: apply_scenario
3616
for scenario in scenarios:
3617
result.addTest(apply_scenario(test, scenario))
3621
def apply_scenario(test, scenario):
3622
"""Copy test and apply scenario to it.
3624
:param test: A test to adapt.
3625
:param scenario: A tuple describing the scenarion.
3626
The first element of the tuple is the new test id.
3627
The second element is a dict containing attributes to set on the
3629
:return: The adapted test.
3631
new_id = "%s(%s)" % (test.id(), scenario[0])
3632
new_test = clone_test(test, new_id)
3633
for name, value in scenario[1].items():
3634
setattr(new_test, name, value)
3638
def clone_test(test, new_id):
3639
"""Clone a test giving it a new id.
3641
:param test: The test to clone.
3642
:param new_id: The id to assign to it.
3643
:return: The new test.
3645
from copy import deepcopy
3646
new_test = deepcopy(test)
3647
new_test.id = lambda: new_id
3651
def _rmtree_temp_dir(dirname):
3652
# If LANG=C we probably have created some bogus paths
3653
# which rmtree(unicode) will fail to delete
3654
# so make sure we are using rmtree(str) to delete everything
3655
# except on win32, where rmtree(str) will fail
3656
# since it doesn't have the property of byte-stream paths
3657
# (they are either ascii or mbcs)
3658
if sys.platform == 'win32':
3659
# make sure we are using the unicode win32 api
3660
dirname = unicode(dirname)
3662
dirname = dirname.encode(sys.getfilesystemencoding())
3664
osutils.rmtree(dirname)
3666
if sys.platform == 'win32' and e.errno == errno.EACCES:
3667
sys.stderr.write(('Permission denied: '
3668
'unable to remove testing dir '
3669
'%s\n' % os.path.basename(dirname)))
3674
class Feature(object):
3675
"""An operating system Feature."""
3678
self._available = None
3680
def available(self):
3681
"""Is the feature available?
3683
:return: True if the feature is available.
3685
if self._available is None:
3686
self._available = self._probe()
3687
return self._available
3690
"""Implement this method in concrete features.
3692
:return: True if the feature is available.
3694
raise NotImplementedError
3697
if getattr(self, 'feature_name', None):
3698
return self.feature_name()
3699
return self.__class__.__name__
3702
class _SymlinkFeature(Feature):
3705
return osutils.has_symlinks()
3707
def feature_name(self):
3710
SymlinkFeature = _SymlinkFeature()
3713
class _HardlinkFeature(Feature):
3716
return osutils.has_hardlinks()
3718
def feature_name(self):
3721
HardlinkFeature = _HardlinkFeature()
3724
class _OsFifoFeature(Feature):
3727
return getattr(os, 'mkfifo', None)
3729
def feature_name(self):
3730
return 'filesystem fifos'
3732
OsFifoFeature = _OsFifoFeature()
3735
class _UnicodeFilenameFeature(Feature):
3736
"""Does the filesystem support Unicode filenames?"""
3740
# Check for character combinations unlikely to be covered by any
3741
# single non-unicode encoding. We use the characters
3742
# - greek small letter alpha (U+03B1) and
3743
# - braille pattern dots-123456 (U+283F).
3744
os.stat(u'\u03b1\u283f')
3745
except UnicodeEncodeError:
3747
except (IOError, OSError):
3748
# The filesystem allows the Unicode filename but the file doesn't
3752
# The filesystem allows the Unicode filename and the file exists,
3756
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3759
def probe_unicode_in_user_encoding():
3760
"""Try to encode several unicode strings to use in unicode-aware tests.
3761
Return first successfull match.
3763
:return: (unicode value, encoded plain string value) or (None, None)
3765
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3766
for uni_val in possible_vals:
3768
str_val = uni_val.encode(osutils.get_user_encoding())
3769
except UnicodeEncodeError:
3770
# Try a different character
3773
return uni_val, str_val
3777
def probe_bad_non_ascii(encoding):
3778
"""Try to find [bad] character with code [128..255]
3779
that cannot be decoded to unicode in some encoding.
3780
Return None if all non-ascii characters is valid
3783
for i in xrange(128, 256):
3786
char.decode(encoding)
3787
except UnicodeDecodeError:
3792
class _HTTPSServerFeature(Feature):
3793
"""Some tests want an https Server, check if one is available.
3795
Right now, the only way this is available is under python2.6 which provides
3806
def feature_name(self):
3807
return 'HTTPSServer'
3810
HTTPSServerFeature = _HTTPSServerFeature()
3813
class _UnicodeFilename(Feature):
3814
"""Does the filesystem support Unicode filenames?"""
3819
except UnicodeEncodeError:
3821
except (IOError, OSError):
3822
# The filesystem allows the Unicode filename but the file doesn't
3826
# The filesystem allows the Unicode filename and the file exists,
3830
UnicodeFilename = _UnicodeFilename()
3833
class _UTF8Filesystem(Feature):
3834
"""Is the filesystem UTF-8?"""
3837
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3841
UTF8Filesystem = _UTF8Filesystem()
3844
class _CaseInsCasePresFilenameFeature(Feature):
3845
"""Is the file-system case insensitive, but case-preserving?"""
3848
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3850
# first check truly case-preserving for created files, then check
3851
# case insensitive when opening existing files.
3852
name = osutils.normpath(name)
3853
base, rel = osutils.split(name)
3854
found_rel = osutils.canonical_relpath(base, name)
3855
return (found_rel == rel
3856
and os.path.isfile(name.upper())
3857
and os.path.isfile(name.lower()))
3862
def feature_name(self):
3863
return "case-insensitive case-preserving filesystem"
3865
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3868
class _CaseInsensitiveFilesystemFeature(Feature):
3869
"""Check if underlying filesystem is case-insensitive but *not* case
3872
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3873
# more likely to be case preserving, so this case is rare.
3876
if CaseInsCasePresFilenameFeature.available():
3879
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3880
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3881
TestCaseWithMemoryTransport.TEST_ROOT = root
3883
root = TestCaseWithMemoryTransport.TEST_ROOT
3884
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3886
name_a = osutils.pathjoin(tdir, 'a')
3887
name_A = osutils.pathjoin(tdir, 'A')
3889
result = osutils.isdir(name_A)
3890
_rmtree_temp_dir(tdir)
3893
def feature_name(self):
3894
return 'case-insensitive filesystem'
3896
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3899
class _SubUnitFeature(Feature):
3900
"""Check if subunit is available."""
3909
def feature_name(self):
3912
SubUnitFeature = _SubUnitFeature()
3913
# Only define SubUnitBzrRunner if subunit is available.
3915
from subunit import TestProtocolClient
3916
class SubUnitBzrRunner(TextTestRunner):
3917
def run(self, test):
3918
# undo out claim for testing which looks like a test start to subunit
3919
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3920
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
