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"
548
from testtools import ThreadsafeForwardingResult
552
if type(result) == ThreadsafeForwardingResult:
553
test.run(BZRTransformingResult(result))
556
run = result.testsRun
558
stopTime = time.time()
559
timeTaken = stopTime - startTime
561
self.stream.writeln(result.separator2)
562
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
563
run, run != 1 and "s" or "", timeTaken))
564
self.stream.writeln()
565
if not result.wasSuccessful():
566
self.stream.write("FAILED (")
567
failed, errored = map(len, (result.failures, result.errors))
569
self.stream.write("failures=%d" % failed)
571
if failed: self.stream.write(", ")
572
self.stream.write("errors=%d" % errored)
573
if result.known_failure_count:
574
if failed or errored: self.stream.write(", ")
575
self.stream.write("known_failure_count=%d" %
576
result.known_failure_count)
577
self.stream.writeln(")")
579
if result.known_failure_count:
580
self.stream.writeln("OK (known_failures=%d)" %
581
result.known_failure_count)
583
self.stream.writeln("OK")
584
if result.skip_count > 0:
585
skipped = result.skip_count
586
self.stream.writeln('%d test%s skipped' %
587
(skipped, skipped != 1 and "s" or ""))
588
if result.unsupported:
589
for feature, count in sorted(result.unsupported.items()):
590
self.stream.writeln("Missing feature '%s' skipped %d tests." %
596
def iter_suite_tests(suite):
597
"""Return all tests in a suite, recursing through nested suites"""
598
if isinstance(suite, unittest.TestCase):
600
elif isinstance(suite, unittest.TestSuite):
602
for r in iter_suite_tests(item):
605
raise Exception('unknown type %r for object %r'
606
% (type(suite), suite))
609
class TestSkipped(Exception):
610
"""Indicates that a test was intentionally skipped, rather than failing."""
613
class TestNotApplicable(TestSkipped):
614
"""A test is not applicable to the situation where it was run.
616
This is only normally raised by parameterized tests, if they find that
617
the instance they're constructed upon does not support one aspect
622
class KnownFailure(AssertionError):
623
"""Indicates that a test failed in a precisely expected manner.
625
Such failures dont block the whole test suite from passing because they are
626
indicators of partially completed code or of future work. We have an
627
explicit error for them so that we can ensure that they are always visible:
628
KnownFailures are always shown in the output of bzr selftest.
632
class UnavailableFeature(Exception):
633
"""A feature required for this test was not available.
635
The feature should be used to construct the exception.
639
class CommandFailed(Exception):
643
class StringIOWrapper(object):
644
"""A wrapper around cStringIO which just adds an encoding attribute.
646
Internally we can check sys.stdout to see what the output encoding
647
should be. However, cStringIO has no encoding attribute that we can
648
set. So we wrap it instead.
653
def __init__(self, s=None):
655
self.__dict__['_cstring'] = StringIO(s)
657
self.__dict__['_cstring'] = StringIO()
659
def __getattr__(self, name, getattr=getattr):
660
return getattr(self.__dict__['_cstring'], name)
662
def __setattr__(self, name, val):
663
if name == 'encoding':
664
self.__dict__['encoding'] = val
666
return setattr(self._cstring, name, val)
669
class TestUIFactory(ui.CLIUIFactory):
670
"""A UI Factory for testing.
672
Hide the progress bar but emit note()s.
674
Allows get_password to be tested without real tty attached.
681
super(TestUIFactory, self).__init__()
682
if stdin is not None:
683
# We use a StringIOWrapper to be able to test various
684
# encodings, but the user is still responsible to
685
# encode the string and to set the encoding attribute
686
# of StringIOWrapper.
687
self.stdin = StringIOWrapper(stdin)
689
self.stdout = sys.stdout
693
self.stderr = sys.stderr
698
"""See progress.ProgressBar.clear()."""
700
def clear_term(self):
701
"""See progress.ProgressBar.clear_term()."""
703
def clear_term(self):
704
"""See progress.ProgressBar.clear_term()."""
707
"""See progress.ProgressBar.finished()."""
709
def note(self, fmt_string, *args, **kwargs):
710
"""See progress.ProgressBar.note()."""
711
self.stdout.write((fmt_string + "\n") % args)
713
def progress_bar(self):
716
def nested_progress_bar(self):
719
def update(self, message, count=None, total=None):
720
"""See progress.ProgressBar.update()."""
722
def get_non_echoed_password(self, prompt):
723
"""Get password from stdin without trying to handle the echo mode"""
725
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
726
password = self.stdin.readline()
729
if password[-1] == '\n':
730
password = password[:-1]
734
def _report_leaked_threads():
735
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
736
TestCase._first_thread_leaker_id,
737
TestCase._leaking_threads_tests)
740
class TestCase(unittest.TestCase):
741
"""Base class for bzr unit tests.
743
Tests that need access to disk resources should subclass
744
TestCaseInTempDir not TestCase.
746
Error and debug log messages are redirected from their usual
747
location into a temporary file, the contents of which can be
748
retrieved by _get_log(). We use a real OS file, not an in-memory object,
749
so that it can also capture file IO. When the test completes this file
750
is read into memory and removed from disk.
752
There are also convenience functions to invoke bzr's command-line
753
routine, and to build and check bzr trees.
755
In addition to the usual method of overriding tearDown(), this class also
756
allows subclasses to register functions into the _cleanups list, which is
757
run in order as the object is torn down. It's less likely this will be
758
accidentally overlooked.
761
_active_threads = None
762
_leaking_threads_tests = 0
763
_first_thread_leaker_id = None
764
_log_file_name = None
766
_keep_log_file = False
767
# record lsprof data when performing benchmark calls.
768
_gather_lsprof_in_benchmarks = False
769
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
770
'_log_contents', '_log_file_name', '_benchtime',
771
'_TestCase__testMethodName')
773
def __init__(self, methodName='testMethod'):
774
super(TestCase, self).__init__(methodName)
776
self._bzr_test_setUp_run = False
777
self._bzr_test_tearDown_run = False
780
unittest.TestCase.setUp(self)
781
self._bzr_test_setUp_run = True
782
self._cleanEnvironment()
785
self._benchcalls = []
786
self._benchtime = None
788
self._clear_debug_flags()
789
TestCase._active_threads = threading.activeCount()
790
self.addCleanup(self._check_leaked_threads)
795
pdb.Pdb().set_trace(sys._getframe().f_back)
797
def _check_leaked_threads(self):
798
active = threading.activeCount()
799
leaked_threads = active - TestCase._active_threads
800
TestCase._active_threads = active
802
TestCase._leaking_threads_tests += 1
803
if TestCase._first_thread_leaker_id is None:
804
TestCase._first_thread_leaker_id = self.id()
805
# we're not specifically told when all tests are finished.
806
# This will do. We use a function to avoid keeping a reference
807
# to a TestCase object.
808
atexit.register(_report_leaked_threads)
810
def _clear_debug_flags(self):
811
"""Prevent externally set debug flags affecting tests.
813
Tests that want to use debug flags can just set them in the
814
debug_flags set during setup/teardown.
816
self._preserved_debug_flags = set(debug.debug_flags)
817
if 'allow_debug' not in selftest_debug_flags:
818
debug.debug_flags.clear()
819
self.addCleanup(self._restore_debug_flags)
821
def _clear_hooks(self):
822
# prevent hooks affecting tests
823
self._preserved_hooks = {}
824
for key, factory in hooks.known_hooks.items():
825
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
826
current_hooks = hooks.known_hooks_key_to_object(key)
827
self._preserved_hooks[parent] = (name, current_hooks)
828
self.addCleanup(self._restoreHooks)
829
for key, factory in hooks.known_hooks.items():
830
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
831
setattr(parent, name, factory())
832
# this hook should always be installed
833
request._install_hook()
835
def _silenceUI(self):
836
"""Turn off UI for duration of test"""
837
# by default the UI is off; tests can turn it on if they want it.
838
saved = ui.ui_factory
840
ui.ui_factory = saved
841
ui.ui_factory = ui.SilentUIFactory()
842
self.addCleanup(_restore)
844
def _ndiff_strings(self, a, b):
845
"""Return ndiff between two strings containing lines.
847
A trailing newline is added if missing to make the strings
849
if b and b[-1] != '\n':
851
if a and a[-1] != '\n':
853
difflines = difflib.ndiff(a.splitlines(True),
855
linejunk=lambda x: False,
856
charjunk=lambda x: False)
857
return ''.join(difflines)
859
def assertEqual(self, a, b, message=''):
863
except UnicodeError, e:
864
# If we can't compare without getting a UnicodeError, then
865
# obviously they are different
866
mutter('UnicodeError: %s', e)
869
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
871
pformat(a), pformat(b)))
873
assertEquals = assertEqual
875
def assertEqualDiff(self, a, b, message=None):
876
"""Assert two texts are equal, if not raise an exception.
878
This is intended for use with multi-line strings where it can
879
be hard to find the differences by eye.
881
# TODO: perhaps override assertEquals to call this for strings?
885
message = "texts not equal:\n"
887
message = 'first string is missing a final newline.\n'
889
message = 'second string is missing a final newline.\n'
890
raise AssertionError(message +
891
self._ndiff_strings(a, b))
893
def assertEqualMode(self, mode, mode_test):
894
self.assertEqual(mode, mode_test,
895
'mode mismatch %o != %o' % (mode, mode_test))
897
def assertEqualStat(self, expected, actual):
898
"""assert that expected and actual are the same stat result.
900
:param expected: A stat result.
901
:param actual: A stat result.
902
:raises AssertionError: If the expected and actual stat values differ
905
self.assertEqual(expected.st_size, actual.st_size)
906
self.assertEqual(expected.st_mtime, actual.st_mtime)
907
self.assertEqual(expected.st_ctime, actual.st_ctime)
908
self.assertEqual(expected.st_dev, actual.st_dev)
909
self.assertEqual(expected.st_ino, actual.st_ino)
910
self.assertEqual(expected.st_mode, actual.st_mode)
912
def assertLength(self, length, obj_with_len):
913
"""Assert that obj_with_len is of length length."""
914
if len(obj_with_len) != length:
915
self.fail("Incorrect length: wanted %d, got %d for %r" % (
916
length, len(obj_with_len), obj_with_len))
918
def assertPositive(self, val):
919
"""Assert that val is greater than 0."""
920
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
922
def assertNegative(self, val):
923
"""Assert that val is less than 0."""
924
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
926
def assertStartsWith(self, s, prefix):
927
if not s.startswith(prefix):
928
raise AssertionError('string %r does not start with %r' % (s, prefix))
930
def assertEndsWith(self, s, suffix):
931
"""Asserts that s ends with suffix."""
932
if not s.endswith(suffix):
933
raise AssertionError('string %r does not end with %r' % (s, suffix))
935
def assertContainsRe(self, haystack, needle_re, flags=0):
936
"""Assert that a contains something matching a regular expression."""
937
if not re.search(needle_re, haystack, flags):
938
if '\n' in haystack or len(haystack) > 60:
939
# a long string, format it in a more readable way
940
raise AssertionError(
941
'pattern "%s" not found in\n"""\\\n%s"""\n'
942
% (needle_re, haystack))
944
raise AssertionError('pattern "%s" not found in "%s"'
945
% (needle_re, haystack))
947
def assertNotContainsRe(self, haystack, needle_re, flags=0):
948
"""Assert that a does not match a regular expression"""
949
if re.search(needle_re, haystack, flags):
950
raise AssertionError('pattern "%s" found in "%s"'
951
% (needle_re, haystack))
953
def assertSubset(self, sublist, superlist):
954
"""Assert that every entry in sublist is present in superlist."""
955
missing = set(sublist) - set(superlist)
957
raise AssertionError("value(s) %r not present in container %r" %
958
(missing, superlist))
960
def assertListRaises(self, excClass, func, *args, **kwargs):
961
"""Fail unless excClass is raised when the iterator from func is used.
963
Many functions can return generators this makes sure
964
to wrap them in a list() call to make sure the whole generator
965
is run, and that the proper exception is raised.
968
list(func(*args, **kwargs))
972
if getattr(excClass,'__name__', None) is not None:
973
excName = excClass.__name__
975
excName = str(excClass)
976
raise self.failureException, "%s not raised" % excName
978
def assertRaises(self, excClass, callableObj, *args, **kwargs):
979
"""Assert that a callable raises a particular exception.
981
:param excClass: As for the except statement, this may be either an
982
exception class, or a tuple of classes.
983
:param callableObj: A callable, will be passed ``*args`` and
986
Returns the exception so that you can examine it.
989
callableObj(*args, **kwargs)
993
if getattr(excClass,'__name__', None) is not None:
994
excName = excClass.__name__
997
excName = str(excClass)
998
raise self.failureException, "%s not raised" % excName
1000
def assertIs(self, left, right, message=None):
1001
if not (left is right):
1002
if message is not None:
1003
raise AssertionError(message)
1005
raise AssertionError("%r is not %r." % (left, right))
1007
def assertIsNot(self, left, right, message=None):
1009
if message is not None:
1010
raise AssertionError(message)
1012
raise AssertionError("%r is %r." % (left, right))
1014
def assertTransportMode(self, transport, path, mode):
1015
"""Fail if a path does not have mode mode.
1017
If modes are not supported on this transport, the assertion is ignored.
1019
if not transport._can_roundtrip_unix_modebits():
1021
path_stat = transport.stat(path)
1022
actual_mode = stat.S_IMODE(path_stat.st_mode)
1023
self.assertEqual(mode, actual_mode,
1024
'mode of %r incorrect (%s != %s)'
1025
% (path, oct(mode), oct(actual_mode)))
1027
def assertIsSameRealPath(self, path1, path2):
1028
"""Fail if path1 and path2 points to different files"""
1029
self.assertEqual(osutils.realpath(path1),
1030
osutils.realpath(path2),
1031
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1033
def assertIsInstance(self, obj, kls):
1034
"""Fail if obj is not an instance of kls"""
1035
if not isinstance(obj, kls):
1036
self.fail("%r is an instance of %s rather than %s" % (
1037
obj, obj.__class__, kls))
1039
def expectFailure(self, reason, assertion, *args, **kwargs):
1040
"""Invoke a test, expecting it to fail for the given reason.
1042
This is for assertions that ought to succeed, but currently fail.
1043
(The failure is *expected* but not *wanted*.) Please be very precise
1044
about the failure you're expecting. If a new bug is introduced,
1045
AssertionError should be raised, not KnownFailure.
1047
Frequently, expectFailure should be followed by an opposite assertion.
1050
Intended to be used with a callable that raises AssertionError as the
1051
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1053
Raises KnownFailure if the test fails. Raises AssertionError if the
1058
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1060
self.assertEqual(42, dynamic_val)
1062
This means that a dynamic_val of 54 will cause the test to raise
1063
a KnownFailure. Once math is fixed and the expectFailure is removed,
1064
only a dynamic_val of 42 will allow the test to pass. Anything other
1065
than 54 or 42 will cause an AssertionError.
1068
assertion(*args, **kwargs)
1069
except AssertionError:
1070
raise KnownFailure(reason)
1072
self.fail('Unexpected success. Should have failed: %s' % reason)
1074
def assertFileEqual(self, content, path):
1075
"""Fail if path does not contain 'content'."""
1076
self.failUnlessExists(path)
1077
f = file(path, 'rb')
1082
self.assertEqualDiff(content, s)
1084
def failUnlessExists(self, path):
1085
"""Fail unless path or paths, which may be abs or relative, exist."""
1086
if not isinstance(path, basestring):
1088
self.failUnlessExists(p)
1090
self.failUnless(osutils.lexists(path),path+" does not exist")
1092
def failIfExists(self, path):
1093
"""Fail if path or paths, which may be abs or relative, exist."""
1094
if not isinstance(path, basestring):
1096
self.failIfExists(p)
1098
self.failIf(osutils.lexists(path),path+" exists")
1100
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1101
"""A helper for callDeprecated and applyDeprecated.
1103
:param a_callable: A callable to call.
1104
:param args: The positional arguments for the callable
1105
:param kwargs: The keyword arguments for the callable
1106
:return: A tuple (warnings, result). result is the result of calling
1107
a_callable(``*args``, ``**kwargs``).
1110
def capture_warnings(msg, cls=None, stacklevel=None):
1111
# we've hooked into a deprecation specific callpath,
1112
# only deprecations should getting sent via it.
1113
self.assertEqual(cls, DeprecationWarning)
1114
local_warnings.append(msg)
1115
original_warning_method = symbol_versioning.warn
1116
symbol_versioning.set_warning_method(capture_warnings)
1118
result = a_callable(*args, **kwargs)
1120
symbol_versioning.set_warning_method(original_warning_method)
1121
return (local_warnings, result)
1123
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1124
"""Call a deprecated callable without warning the user.
1126
Note that this only captures warnings raised by symbol_versioning.warn,
1127
not other callers that go direct to the warning module.
1129
To test that a deprecated method raises an error, do something like
1132
self.assertRaises(errors.ReservedId,
1133
self.applyDeprecated,
1134
deprecated_in((1, 5, 0)),
1138
:param deprecation_format: The deprecation format that the callable
1139
should have been deprecated with. This is the same type as the
1140
parameter to deprecated_method/deprecated_function. If the
1141
callable is not deprecated with this format, an assertion error
1143
:param a_callable: A callable to call. This may be a bound method or
1144
a regular function. It will be called with ``*args`` and
1146
:param args: The positional arguments for the callable
1147
:param kwargs: The keyword arguments for the callable
1148
:return: The result of a_callable(``*args``, ``**kwargs``)
1150
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1152
expected_first_warning = symbol_versioning.deprecation_string(
1153
a_callable, deprecation_format)
1154
if len(call_warnings) == 0:
1155
self.fail("No deprecation warning generated by call to %s" %
1157
self.assertEqual(expected_first_warning, call_warnings[0])
1160
def callCatchWarnings(self, fn, *args, **kw):
1161
"""Call a callable that raises python warnings.
1163
The caller's responsible for examining the returned warnings.
1165
If the callable raises an exception, the exception is not
1166
caught and propagates up to the caller. In that case, the list
1167
of warnings is not available.
1169
:returns: ([warning_object, ...], fn_result)
1171
# XXX: This is not perfect, because it completely overrides the
1172
# warnings filters, and some code may depend on suppressing particular
1173
# warnings. It's the easiest way to insulate ourselves from -Werror,
1174
# though. -- Andrew, 20071062
1176
def _catcher(message, category, filename, lineno, file=None, line=None):
1177
# despite the name, 'message' is normally(?) a Warning subclass
1179
wlist.append(message)
1180
saved_showwarning = warnings.showwarning
1181
saved_filters = warnings.filters
1183
warnings.showwarning = _catcher
1184
warnings.filters = []
1185
result = fn(*args, **kw)
1187
warnings.showwarning = saved_showwarning
1188
warnings.filters = saved_filters
1189
return wlist, result
1191
def callDeprecated(self, expected, callable, *args, **kwargs):
1192
"""Assert that a callable is deprecated in a particular way.
1194
This is a very precise test for unusual requirements. The
1195
applyDeprecated helper function is probably more suited for most tests
1196
as it allows you to simply specify the deprecation format being used
1197
and will ensure that that is issued for the function being called.
1199
Note that this only captures warnings raised by symbol_versioning.warn,
1200
not other callers that go direct to the warning module. To catch
1201
general warnings, use callCatchWarnings.
1203
:param expected: a list of the deprecation warnings expected, in order
1204
:param callable: The callable to call
1205
:param args: The positional arguments for the callable
1206
:param kwargs: The keyword arguments for the callable
1208
call_warnings, result = self._capture_deprecation_warnings(callable,
1210
self.assertEqual(expected, call_warnings)
1213
def _startLogFile(self):
1214
"""Send bzr and test log messages to a temporary file.
1216
The file is removed as the test is torn down.
1218
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1219
self._log_file = os.fdopen(fileno, 'w+')
1220
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1221
self._log_file_name = name
1222
self.addCleanup(self._finishLogFile)
1224
def _finishLogFile(self):
1225
"""Finished with the log file.
1227
Close the file and delete it, unless setKeepLogfile was called.
1229
if self._log_file is None:
1231
bzrlib.trace.pop_log_file(self._log_memento)
1232
self._log_file.close()
1233
self._log_file = None
1234
if not self._keep_log_file:
1235
os.remove(self._log_file_name)
1236
self._log_file_name = None
1238
def setKeepLogfile(self):
1239
"""Make the logfile not be deleted when _finishLogFile is called."""
1240
self._keep_log_file = True
1242
def addCleanup(self, callable, *args, **kwargs):
1243
"""Arrange to run a callable when this case is torn down.
1245
Callables are run in the reverse of the order they are registered,
1246
ie last-in first-out.
1248
self._cleanups.append((callable, args, kwargs))
1250
def _cleanEnvironment(self):
1252
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1253
'HOME': os.getcwd(),
1254
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1255
# tests do check our impls match APPDATA
1256
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1260
'BZREMAIL': None, # may still be present in the environment
1262
'BZR_PROGRESS_BAR': None,
1264
'BZR_PLUGIN_PATH': None,
1266
'SSH_AUTH_SOCK': None,
1270
'https_proxy': None,
1271
'HTTPS_PROXY': None,
1276
# Nobody cares about these ones AFAIK. So far at
1277
# least. If you do (care), please update this comment
1281
'BZR_REMOTE_PATH': None,
1284
self.addCleanup(self._restoreEnvironment)
1285
for name, value in new_env.iteritems():
1286
self._captureVar(name, value)
1288
def _captureVar(self, name, newvalue):
1289
"""Set an environment variable, and reset it when finished."""
1290
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1292
def _restore_debug_flags(self):
1293
debug.debug_flags.clear()
1294
debug.debug_flags.update(self._preserved_debug_flags)
1296
def _restoreEnvironment(self):
1297
for name, value in self.__old_env.iteritems():
1298
osutils.set_or_unset_env(name, value)
1300
def _restoreHooks(self):
1301
for klass, (name, hooks) in self._preserved_hooks.items():
1302
setattr(klass, name, hooks)
1304
def knownFailure(self, reason):
1305
"""This test has failed for some known reason."""
1306
raise KnownFailure(reason)
1308
def _do_skip(self, result, reason):
1309
addSkip = getattr(result, 'addSkip', None)
1310
if not callable(addSkip):
1311
result.addError(self, sys.exc_info())
1313
addSkip(self, reason)
1315
def run(self, result=None):
1316
if result is None: result = self.defaultTestResult()
1317
for feature in getattr(self, '_test_needs_features', []):
1318
if not feature.available():
1319
result.startTest(self)
1320
if getattr(result, 'addNotSupported', None):
1321
result.addNotSupported(self, feature)
1323
result.addSuccess(self)
1324
result.stopTest(self)
1328
result.startTest(self)
1329
absent_attr = object()
1331
method_name = getattr(self, '_testMethodName', absent_attr)
1332
if method_name is absent_attr:
1334
method_name = getattr(self, '_TestCase__testMethodName')
1335
testMethod = getattr(self, method_name)
1339
if not self._bzr_test_setUp_run:
1341
"test setUp did not invoke "
1342
"bzrlib.tests.TestCase's setUp")
1343
except KeyboardInterrupt:
1345
except TestSkipped, e:
1346
self._do_skip(result, e.args[0])
1350
result.addError(self, sys.exc_info())
1357
except self.failureException:
1358
result.addFailure(self, sys.exc_info())
1359
except TestSkipped, e:
1361
reason = "No reason given."
1364
self._do_skip(result, reason)
1365
except KeyboardInterrupt:
1368
result.addError(self, sys.exc_info())
1372
if not self._bzr_test_tearDown_run:
1374
"test tearDown did not invoke "
1375
"bzrlib.tests.TestCase's tearDown")
1376
except KeyboardInterrupt:
1379
result.addError(self, sys.exc_info())
1381
if ok: result.addSuccess(self)
1383
result.stopTest(self)
1385
except TestNotApplicable:
1386
# Not moved from the result [yet].
1388
except KeyboardInterrupt:
1392
absent_attr = object()
1393
for attr_name in self.attrs_to_keep:
1394
attr = getattr(self, attr_name, absent_attr)
1395
if attr is not absent_attr:
1396
saved_attrs[attr_name] = attr
1397
self.__dict__ = saved_attrs
1400
self._bzr_test_tearDown_run = True
1402
self._log_contents = ''
1403
unittest.TestCase.tearDown(self)
1405
def time(self, callable, *args, **kwargs):
1406
"""Run callable and accrue the time it takes to the benchmark time.
1408
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1409
this will cause lsprofile statistics to be gathered and stored in
1412
if self._benchtime is None:
1416
if not self._gather_lsprof_in_benchmarks:
1417
return callable(*args, **kwargs)
1419
# record this benchmark
1420
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1422
self._benchcalls.append(((callable, args, kwargs), stats))
1425
self._benchtime += time.time() - start
1427
def _runCleanups(self):
1428
"""Run registered cleanup functions.
1430
This should only be called from TestCase.tearDown.
1432
# TODO: Perhaps this should keep running cleanups even if
1433
# one of them fails?
1435
# Actually pop the cleanups from the list so tearDown running
1436
# twice is safe (this happens for skipped tests).
1437
while self._cleanups:
1438
cleanup, args, kwargs = self._cleanups.pop()
1439
cleanup(*args, **kwargs)
1441
def log(self, *args):
1444
def _get_log(self, keep_log_file=False):
1445
"""Get the log from bzrlib.trace calls from this test.
1447
:param keep_log_file: When True, if the log is still a file on disk
1448
leave it as a file on disk. When False, if the log is still a file
1449
on disk, the log file is deleted and the log preserved as
1451
:return: A string containing the log.
1453
# flush the log file, to get all content
1455
if bzrlib.trace._trace_file:
1456
bzrlib.trace._trace_file.flush()
1457
if self._log_contents:
1458
# XXX: this can hardly contain the content flushed above --vila
1460
return self._log_contents
1461
if self._log_file_name is not None:
1462
logfile = open(self._log_file_name)
1464
log_contents = logfile.read()
1467
if not keep_log_file:
1468
self._log_contents = log_contents
1470
os.remove(self._log_file_name)
1472
if sys.platform == 'win32' and e.errno == errno.EACCES:
1473
sys.stderr.write(('Unable to delete log file '
1474
' %r\n' % self._log_file_name))
1479
return "DELETED log file to reduce memory footprint"
1481
def requireFeature(self, feature):
1482
"""This test requires a specific feature is available.
1484
:raises UnavailableFeature: When feature is not available.
1486
if not feature.available():
1487
raise UnavailableFeature(feature)
1489
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1491
"""Run bazaar command line, splitting up a string command line."""
1492
if isinstance(args, basestring):
1493
# shlex don't understand unicode strings,
1494
# so args should be plain string (bialix 20070906)
1495
args = list(shlex.split(str(args)))
1496
return self._run_bzr_core(args, retcode=retcode,
1497
encoding=encoding, stdin=stdin, working_dir=working_dir,
1500
def _run_bzr_core(self, args, retcode, encoding, stdin,
1502
if encoding is None:
1503
encoding = osutils.get_user_encoding()
1504
stdout = StringIOWrapper()
1505
stderr = StringIOWrapper()
1506
stdout.encoding = encoding
1507
stderr.encoding = encoding
1509
self.log('run bzr: %r', args)
1510
# FIXME: don't call into logging here
1511
handler = logging.StreamHandler(stderr)
1512
handler.setLevel(logging.INFO)
1513
logger = logging.getLogger('')
1514
logger.addHandler(handler)
1515
old_ui_factory = ui.ui_factory
1516
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1519
if working_dir is not None:
1520
cwd = osutils.getcwd()
1521
os.chdir(working_dir)
1524
result = self.apply_redirected(ui.ui_factory.stdin,
1526
bzrlib.commands.run_bzr_catch_user_errors,
1529
logger.removeHandler(handler)
1530
ui.ui_factory = old_ui_factory
1534
out = stdout.getvalue()
1535
err = stderr.getvalue()
1537
self.log('output:\n%r', out)
1539
self.log('errors:\n%r', err)
1540
if retcode is not None:
1541
self.assertEquals(retcode, result,
1542
message='Unexpected return code')
1545
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1546
working_dir=None, error_regexes=[], output_encoding=None):
1547
"""Invoke bzr, as if it were run from the command line.
1549
The argument list should not include the bzr program name - the
1550
first argument is normally the bzr command. Arguments may be
1551
passed in three ways:
1553
1- A list of strings, eg ["commit", "a"]. This is recommended
1554
when the command contains whitespace or metacharacters, or
1555
is built up at run time.
1557
2- A single string, eg "add a". This is the most convenient
1558
for hardcoded commands.
1560
This runs bzr through the interface that catches and reports
1561
errors, and with logging set to something approximating the
1562
default, so that error reporting can be checked.
1564
This should be the main method for tests that want to exercise the
1565
overall behavior of the bzr application (rather than a unit test
1566
or a functional test of the library.)
1568
This sends the stdout/stderr results into the test's log,
1569
where it may be useful for debugging. See also run_captured.
1571
:keyword stdin: A string to be used as stdin for the command.
1572
:keyword retcode: The status code the command should return;
1574
:keyword working_dir: The directory to run the command in
1575
:keyword error_regexes: A list of expected error messages. If
1576
specified they must be seen in the error output of the command.
1578
out, err = self._run_bzr_autosplit(
1583
working_dir=working_dir,
1585
for regex in error_regexes:
1586
self.assertContainsRe(err, regex)
1589
def run_bzr_error(self, error_regexes, *args, **kwargs):
1590
"""Run bzr, and check that stderr contains the supplied regexes
1592
:param error_regexes: Sequence of regular expressions which
1593
must each be found in the error output. The relative ordering
1595
:param args: command-line arguments for bzr
1596
:param kwargs: Keyword arguments which are interpreted by run_bzr
1597
This function changes the default value of retcode to be 3,
1598
since in most cases this is run when you expect bzr to fail.
1600
:return: (out, err) The actual output of running the command (in case
1601
you want to do more inspection)
1605
# Make sure that commit is failing because there is nothing to do
1606
self.run_bzr_error(['no changes to commit'],
1607
['commit', '-m', 'my commit comment'])
1608
# Make sure --strict is handling an unknown file, rather than
1609
# giving us the 'nothing to do' error
1610
self.build_tree(['unknown'])
1611
self.run_bzr_error(['Commit refused because there are unknown files'],
1612
['commit', --strict', '-m', 'my commit comment'])
1614
kwargs.setdefault('retcode', 3)
1615
kwargs['error_regexes'] = error_regexes
1616
out, err = self.run_bzr(*args, **kwargs)
1619
def run_bzr_subprocess(self, *args, **kwargs):
1620
"""Run bzr in a subprocess for testing.
1622
This starts a new Python interpreter and runs bzr in there.
1623
This should only be used for tests that have a justifiable need for
1624
this isolation: e.g. they are testing startup time, or signal
1625
handling, or early startup code, etc. Subprocess code can't be
1626
profiled or debugged so easily.
1628
:keyword retcode: The status code that is expected. Defaults to 0. If
1629
None is supplied, the status code is not checked.
1630
:keyword env_changes: A dictionary which lists changes to environment
1631
variables. A value of None will unset the env variable.
1632
The values must be strings. The change will only occur in the
1633
child, so you don't need to fix the environment after running.
1634
:keyword universal_newlines: Convert CRLF => LF
1635
:keyword allow_plugins: By default the subprocess is run with
1636
--no-plugins to ensure test reproducibility. Also, it is possible
1637
for system-wide plugins to create unexpected output on stderr,
1638
which can cause unnecessary test failures.
1640
env_changes = kwargs.get('env_changes', {})
1641
working_dir = kwargs.get('working_dir', None)
1642
allow_plugins = kwargs.get('allow_plugins', False)
1644
if isinstance(args[0], list):
1646
elif isinstance(args[0], basestring):
1647
args = list(shlex.split(args[0]))
1649
raise ValueError("passing varargs to run_bzr_subprocess")
1650
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1651
working_dir=working_dir,
1652
allow_plugins=allow_plugins)
1653
# We distinguish between retcode=None and retcode not passed.
1654
supplied_retcode = kwargs.get('retcode', 0)
1655
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1656
universal_newlines=kwargs.get('universal_newlines', False),
1659
def start_bzr_subprocess(self, process_args, env_changes=None,
1660
skip_if_plan_to_signal=False,
1662
allow_plugins=False):
1663
"""Start bzr in a subprocess for testing.
1665
This starts a new Python interpreter and runs bzr in there.
1666
This should only be used for tests that have a justifiable need for
1667
this isolation: e.g. they are testing startup time, or signal
1668
handling, or early startup code, etc. Subprocess code can't be
1669
profiled or debugged so easily.
1671
:param process_args: a list of arguments to pass to the bzr executable,
1672
for example ``['--version']``.
1673
:param env_changes: A dictionary which lists changes to environment
1674
variables. A value of None will unset the env variable.
1675
The values must be strings. The change will only occur in the
1676
child, so you don't need to fix the environment after running.
1677
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1679
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1681
:returns: Popen object for the started process.
1683
if skip_if_plan_to_signal:
1684
if not getattr(os, 'kill', None):
1685
raise TestSkipped("os.kill not available.")
1687
if env_changes is None:
1691
def cleanup_environment():
1692
for env_var, value in env_changes.iteritems():
1693
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1695
def restore_environment():
1696
for env_var, value in old_env.iteritems():
1697
osutils.set_or_unset_env(env_var, value)
1699
bzr_path = self.get_bzr_path()
1702
if working_dir is not None:
1703
cwd = osutils.getcwd()
1704
os.chdir(working_dir)
1707
# win32 subprocess doesn't support preexec_fn
1708
# so we will avoid using it on all platforms, just to
1709
# make sure the code path is used, and we don't break on win32
1710
cleanup_environment()
1711
command = [sys.executable]
1712
# frozen executables don't need the path to bzr
1713
if getattr(sys, "frozen", None) is None:
1714
command.append(bzr_path)
1715
if not allow_plugins:
1716
command.append('--no-plugins')
1717
command.extend(process_args)
1718
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1720
restore_environment()
1726
def _popen(self, *args, **kwargs):
1727
"""Place a call to Popen.
1729
Allows tests to override this method to intercept the calls made to
1730
Popen for introspection.
1732
return Popen(*args, **kwargs)
1734
def get_bzr_path(self):
1735
"""Return the path of the 'bzr' executable for this test suite."""
1736
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1737
if not os.path.isfile(bzr_path):
1738
# We are probably installed. Assume sys.argv is the right file
1739
bzr_path = sys.argv[0]
1742
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1743
universal_newlines=False, process_args=None):
1744
"""Finish the execution of process.
1746
:param process: the Popen object returned from start_bzr_subprocess.
1747
:param retcode: The status code that is expected. Defaults to 0. If
1748
None is supplied, the status code is not checked.
1749
:param send_signal: an optional signal to send to the process.
1750
:param universal_newlines: Convert CRLF => LF
1751
:returns: (stdout, stderr)
1753
if send_signal is not None:
1754
os.kill(process.pid, send_signal)
1755
out, err = process.communicate()
1757
if universal_newlines:
1758
out = out.replace('\r\n', '\n')
1759
err = err.replace('\r\n', '\n')
1761
if retcode is not None and retcode != process.returncode:
1762
if process_args is None:
1763
process_args = "(unknown args)"
1764
mutter('Output of bzr %s:\n%s', process_args, out)
1765
mutter('Error for bzr %s:\n%s', process_args, err)
1766
self.fail('Command bzr %s failed with retcode %s != %s'
1767
% (process_args, retcode, process.returncode))
1770
def check_inventory_shape(self, inv, shape):
1771
"""Compare an inventory to a list of expected names.
1773
Fail if they are not precisely equal.
1776
shape = list(shape) # copy
1777
for path, ie in inv.entries():
1778
name = path.replace('\\', '/')
1779
if ie.kind == 'directory':
1786
self.fail("expected paths not found in inventory: %r" % shape)
1788
self.fail("unexpected paths found in inventory: %r" % extras)
1790
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1791
a_callable=None, *args, **kwargs):
1792
"""Call callable with redirected std io pipes.
1794
Returns the return code."""
1795
if not callable(a_callable):
1796
raise ValueError("a_callable must be callable.")
1798
stdin = StringIO("")
1800
if getattr(self, "_log_file", None) is not None:
1801
stdout = self._log_file
1805
if getattr(self, "_log_file", None is not None):
1806
stderr = self._log_file
1809
real_stdin = sys.stdin
1810
real_stdout = sys.stdout
1811
real_stderr = sys.stderr
1816
return a_callable(*args, **kwargs)
1818
sys.stdout = real_stdout
1819
sys.stderr = real_stderr
1820
sys.stdin = real_stdin
1822
def reduceLockdirTimeout(self):
1823
"""Reduce the default lock timeout for the duration of the test, so that
1824
if LockContention occurs during a test, it does so quickly.
1826
Tests that expect to provoke LockContention errors should call this.
1828
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1830
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1831
self.addCleanup(resetTimeout)
1832
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1834
def make_utf8_encoded_stringio(self, encoding_type=None):
1835
"""Return a StringIOWrapper instance, that will encode Unicode
1838
if encoding_type is None:
1839
encoding_type = 'strict'
1841
output_encoding = 'utf-8'
1842
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1843
sio.encoding = output_encoding
1847
class CapturedCall(object):
1848
"""A helper for capturing smart server calls for easy debug analysis."""
1850
def __init__(self, params, prefix_length):
1851
"""Capture the call with params and skip prefix_length stack frames."""
1854
# The last 5 frames are the __init__, the hook frame, and 3 smart
1855
# client frames. Beyond this we could get more clever, but this is good
1857
stack = traceback.extract_stack()[prefix_length:-5]
1858
self.stack = ''.join(traceback.format_list(stack))
1861
return self.call.method
1864
return self.call.method
1870
class TestCaseWithMemoryTransport(TestCase):
1871
"""Common test class for tests that do not need disk resources.
1873
Tests that need disk resources should derive from TestCaseWithTransport.
1875
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1877
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1878
a directory which does not exist. This serves to help ensure test isolation
1879
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1880
must exist. However, TestCaseWithMemoryTransport does not offer local
1881
file defaults for the transport in tests, nor does it obey the command line
1882
override, so tests that accidentally write to the common directory should
1885
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1886
a .bzr directory that stops us ascending higher into the filesystem.
1892
def __init__(self, methodName='runTest'):
1893
# allow test parameterization after test construction and before test
1894
# execution. Variables that the parameterizer sets need to be
1895
# ones that are not set by setUp, or setUp will trash them.
1896
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1897
self.vfs_transport_factory = default_transport
1898
self.transport_server = None
1899
self.transport_readonly_server = None
1900
self.__vfs_server = None
1902
def get_transport(self, relpath=None):
1903
"""Return a writeable transport.
1905
This transport is for the test scratch space relative to
1908
:param relpath: a path relative to the base url.
1910
t = get_transport(self.get_url(relpath))
1911
self.assertFalse(t.is_readonly())
1914
def get_readonly_transport(self, relpath=None):
1915
"""Return a readonly transport for the test scratch space
1917
This can be used to test that operations which should only need
1918
readonly access in fact do not try to write.
1920
:param relpath: a path relative to the base url.
1922
t = get_transport(self.get_readonly_url(relpath))
1923
self.assertTrue(t.is_readonly())
1926
def create_transport_readonly_server(self):
1927
"""Create a transport server from class defined at init.
1929
This is mostly a hook for daughter classes.
1931
return self.transport_readonly_server()
1933
def get_readonly_server(self):
1934
"""Get the server instance for the readonly transport
1936
This is useful for some tests with specific servers to do diagnostics.
1938
if self.__readonly_server is None:
1939
if self.transport_readonly_server is None:
1940
# readonly decorator requested
1941
# bring up the server
1942
self.__readonly_server = ReadonlyServer()
1943
self.__readonly_server.setUp(self.get_vfs_only_server())
1945
self.__readonly_server = self.create_transport_readonly_server()
1946
self.__readonly_server.setUp(self.get_vfs_only_server())
1947
self.addCleanup(self.__readonly_server.tearDown)
1948
return self.__readonly_server
1950
def get_readonly_url(self, relpath=None):
1951
"""Get a URL for the readonly transport.
1953
This will either be backed by '.' or a decorator to the transport
1954
used by self.get_url()
1955
relpath provides for clients to get a path relative to the base url.
1956
These should only be downwards relative, not upwards.
1958
base = self.get_readonly_server().get_url()
1959
return self._adjust_url(base, relpath)
1961
def get_vfs_only_server(self):
1962
"""Get the vfs only read/write server instance.
1964
This is useful for some tests with specific servers that need
1967
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1968
is no means to override it.
1970
if self.__vfs_server is None:
1971
self.__vfs_server = MemoryServer()
1972
self.__vfs_server.setUp()
1973
self.addCleanup(self.__vfs_server.tearDown)
1974
return self.__vfs_server
1976
def get_server(self):
1977
"""Get the read/write server instance.
1979
This is useful for some tests with specific servers that need
1982
This is built from the self.transport_server factory. If that is None,
1983
then the self.get_vfs_server is returned.
1985
if self.__server is None:
1986
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1987
return self.get_vfs_only_server()
1989
# bring up a decorated means of access to the vfs only server.
1990
self.__server = self.transport_server()
1992
self.__server.setUp(self.get_vfs_only_server())
1993
except TypeError, e:
1994
# This should never happen; the try:Except here is to assist
1995
# developers having to update code rather than seeing an
1996
# uninformative TypeError.
1997
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1998
self.addCleanup(self.__server.tearDown)
1999
return self.__server
2001
def _adjust_url(self, base, relpath):
2002
"""Get a URL (or maybe a path) for the readwrite transport.
2004
This will either be backed by '.' or to an equivalent non-file based
2006
relpath provides for clients to get a path relative to the base url.
2007
These should only be downwards relative, not upwards.
2009
if relpath is not None and relpath != '.':
2010
if not base.endswith('/'):
2012
# XXX: Really base should be a url; we did after all call
2013
# get_url()! But sometimes it's just a path (from
2014
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2015
# to a non-escaped local path.
2016
if base.startswith('./') or base.startswith('/'):
2019
base += urlutils.escape(relpath)
2022
def get_url(self, relpath=None):
2023
"""Get a URL (or maybe a path) for the readwrite transport.
2025
This will either be backed by '.' or to an equivalent non-file based
2027
relpath provides for clients to get a path relative to the base url.
2028
These should only be downwards relative, not upwards.
2030
base = self.get_server().get_url()
2031
return self._adjust_url(base, relpath)
2033
def get_vfs_only_url(self, relpath=None):
2034
"""Get a URL (or maybe a path for the plain old vfs transport.
2036
This will never be a smart protocol. It always has all the
2037
capabilities of the local filesystem, but it might actually be a
2038
MemoryTransport or some other similar virtual filesystem.
2040
This is the backing transport (if any) of the server returned by
2041
get_url and get_readonly_url.
2043
:param relpath: provides for clients to get a path relative to the base
2044
url. These should only be downwards relative, not upwards.
2047
base = self.get_vfs_only_server().get_url()
2048
return self._adjust_url(base, relpath)
2050
def _create_safety_net(self):
2051
"""Make a fake bzr directory.
2053
This prevents any tests propagating up onto the TEST_ROOT directory's
2056
root = TestCaseWithMemoryTransport.TEST_ROOT
2057
bzrdir.BzrDir.create_standalone_workingtree(root)
2059
def _check_safety_net(self):
2060
"""Check that the safety .bzr directory have not been touched.
2062
_make_test_root have created a .bzr directory to prevent tests from
2063
propagating. This method ensures than a test did not leaked.
2065
root = TestCaseWithMemoryTransport.TEST_ROOT
2066
wt = workingtree.WorkingTree.open(root)
2067
last_rev = wt.last_revision()
2068
if last_rev != 'null:':
2069
# The current test have modified the /bzr directory, we need to
2070
# recreate a new one or all the followng tests will fail.
2071
# If you need to inspect its content uncomment the following line
2072
# import pdb; pdb.set_trace()
2073
_rmtree_temp_dir(root + '/.bzr')
2074
self._create_safety_net()
2075
raise AssertionError('%s/.bzr should not be modified' % root)
2077
def _make_test_root(self):
2078
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2079
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2080
TestCaseWithMemoryTransport.TEST_ROOT = root
2082
self._create_safety_net()
2084
# The same directory is used by all tests, and we're not
2085
# specifically told when all tests are finished. This will do.
2086
atexit.register(_rmtree_temp_dir, root)
2088
self.addCleanup(self._check_safety_net)
2090
def makeAndChdirToTestDir(self):
2091
"""Create a temporary directories for this one test.
2093
This must set self.test_home_dir and self.test_dir and chdir to
2096
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2098
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2099
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2100
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2102
def make_branch(self, relpath, format=None):
2103
"""Create a branch on the transport at relpath."""
2104
repo = self.make_repository(relpath, format=format)
2105
return repo.bzrdir.create_branch()
2107
def make_bzrdir(self, relpath, format=None):
2109
# might be a relative or absolute path
2110
maybe_a_url = self.get_url(relpath)
2111
segments = maybe_a_url.rsplit('/', 1)
2112
t = get_transport(maybe_a_url)
2113
if len(segments) > 1 and segments[-1] not in ('', '.'):
2117
if isinstance(format, basestring):
2118
format = bzrdir.format_registry.make_bzrdir(format)
2119
return format.initialize_on_transport(t)
2120
except errors.UninitializableFormat:
2121
raise TestSkipped("Format %s is not initializable." % format)
2123
def make_repository(self, relpath, shared=False, format=None):
2124
"""Create a repository on our default transport at relpath.
2126
Note that relpath must be a relative path, not a full url.
2128
# FIXME: If you create a remoterepository this returns the underlying
2129
# real format, which is incorrect. Actually we should make sure that
2130
# RemoteBzrDir returns a RemoteRepository.
2131
# maybe mbp 20070410
2132
made_control = self.make_bzrdir(relpath, format=format)
2133
return made_control.create_repository(shared=shared)
2135
def make_smart_server(self, path):
2136
smart_server = server.SmartTCPServer_for_testing()
2137
smart_server.setUp(self.get_server())
2138
remote_transport = get_transport(smart_server.get_url()).clone(path)
2139
self.addCleanup(smart_server.tearDown)
2140
return remote_transport
2142
def make_branch_and_memory_tree(self, relpath, format=None):
2143
"""Create a branch on the default transport and a MemoryTree for it."""
2144
b = self.make_branch(relpath, format=format)
2145
return memorytree.MemoryTree.create_on_branch(b)
2147
def make_branch_builder(self, relpath, format=None):
2148
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2151
def overrideEnvironmentForTesting(self):
2152
os.environ['HOME'] = self.test_home_dir
2153
os.environ['BZR_HOME'] = self.test_home_dir
2156
super(TestCaseWithMemoryTransport, self).setUp()
2157
self._make_test_root()
2158
_currentdir = os.getcwdu()
2159
def _leaveDirectory():
2160
os.chdir(_currentdir)
2161
self.addCleanup(_leaveDirectory)
2162
self.makeAndChdirToTestDir()
2163
self.overrideEnvironmentForTesting()
2164
self.__readonly_server = None
2165
self.__server = None
2166
self.reduceLockdirTimeout()
2168
def setup_smart_server_with_call_log(self):
2169
"""Sets up a smart server as the transport server with a call log."""
2170
self.transport_server = server.SmartTCPServer_for_testing
2171
self.hpss_calls = []
2173
# Skip the current stack down to the caller of
2174
# setup_smart_server_with_call_log
2175
prefix_length = len(traceback.extract_stack()) - 2
2176
def capture_hpss_call(params):
2177
self.hpss_calls.append(
2178
CapturedCall(params, prefix_length))
2179
client._SmartClient.hooks.install_named_hook(
2180
'call', capture_hpss_call, None)
2182
def reset_smart_call_log(self):
2183
self.hpss_calls = []
2186
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2187
"""Derived class that runs a test within a temporary directory.
2189
This is useful for tests that need to create a branch, etc.
2191
The directory is created in a slightly complex way: for each
2192
Python invocation, a new temporary top-level directory is created.
2193
All test cases create their own directory within that. If the
2194
tests complete successfully, the directory is removed.
2196
:ivar test_base_dir: The path of the top-level directory for this
2197
test, which contains a home directory and a work directory.
2199
:ivar test_home_dir: An initially empty directory under test_base_dir
2200
which is used as $HOME for this test.
2202
:ivar test_dir: A directory under test_base_dir used as the current
2203
directory when the test proper is run.
2206
OVERRIDE_PYTHON = 'python'
2208
def check_file_contents(self, filename, expect):
2209
self.log("check contents of file %s" % filename)
2210
contents = file(filename, 'r').read()
2211
if contents != expect:
2212
self.log("expected: %r" % expect)
2213
self.log("actually: %r" % contents)
2214
self.fail("contents of %s not as expected" % filename)
2216
def _getTestDirPrefix(self):
2217
# create a directory within the top level test directory
2218
if sys.platform == 'win32':
2219
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2220
# windows is likely to have path-length limits so use a short name
2221
name_prefix = name_prefix[-30:]
2223
name_prefix = re.sub('[/]', '_', self.id())
2226
def makeAndChdirToTestDir(self):
2227
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2229
For TestCaseInTempDir we create a temporary directory based on the test
2230
name and then create two subdirs - test and home under it.
2232
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2233
self._getTestDirPrefix())
2235
for i in range(100):
2236
if os.path.exists(name):
2237
name = name_prefix + '_' + str(i)
2241
# now create test and home directories within this dir
2242
self.test_base_dir = name
2243
self.test_home_dir = self.test_base_dir + '/home'
2244
os.mkdir(self.test_home_dir)
2245
self.test_dir = self.test_base_dir + '/work'
2246
os.mkdir(self.test_dir)
2247
os.chdir(self.test_dir)
2248
# put name of test inside
2249
f = file(self.test_base_dir + '/name', 'w')
2254
self.addCleanup(self.deleteTestDir)
2256
def deleteTestDir(self):
2257
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2258
_rmtree_temp_dir(self.test_base_dir)
2260
def build_tree(self, shape, line_endings='binary', transport=None):
2261
"""Build a test tree according to a pattern.
2263
shape is a sequence of file specifications. If the final
2264
character is '/', a directory is created.
2266
This assumes that all the elements in the tree being built are new.
2268
This doesn't add anything to a branch.
2270
:type shape: list or tuple.
2271
:param line_endings: Either 'binary' or 'native'
2272
in binary mode, exact contents are written in native mode, the
2273
line endings match the default platform endings.
2274
:param transport: A transport to write to, for building trees on VFS's.
2275
If the transport is readonly or None, "." is opened automatically.
2278
if type(shape) not in (list, tuple):
2279
raise AssertionError("Parameter 'shape' should be "
2280
"a list or a tuple. Got %r instead" % (shape,))
2281
# It's OK to just create them using forward slashes on windows.
2282
if transport is None or transport.is_readonly():
2283
transport = get_transport(".")
2285
self.assertIsInstance(name, basestring)
2287
transport.mkdir(urlutils.escape(name[:-1]))
2289
if line_endings == 'binary':
2291
elif line_endings == 'native':
2294
raise errors.BzrError(
2295
'Invalid line ending request %r' % line_endings)
2296
content = "contents of %s%s" % (name.encode('utf-8'), end)
2297
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2299
def build_tree_contents(self, shape):
2300
build_tree_contents(shape)
2302
def assertInWorkingTree(self, path, root_path='.', tree=None):
2303
"""Assert whether path or paths are in the WorkingTree"""
2305
tree = workingtree.WorkingTree.open(root_path)
2306
if not isinstance(path, basestring):
2308
self.assertInWorkingTree(p, tree=tree)
2310
self.assertIsNot(tree.path2id(path), None,
2311
path+' not in working tree.')
2313
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2314
"""Assert whether path or paths are not in the WorkingTree"""
2316
tree = workingtree.WorkingTree.open(root_path)
2317
if not isinstance(path, basestring):
2319
self.assertNotInWorkingTree(p,tree=tree)
2321
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2324
class TestCaseWithTransport(TestCaseInTempDir):
2325
"""A test case that provides get_url and get_readonly_url facilities.
2327
These back onto two transport servers, one for readonly access and one for
2330
If no explicit class is provided for readonly access, a
2331
ReadonlyTransportDecorator is used instead which allows the use of non disk
2332
based read write transports.
2334
If an explicit class is provided for readonly access, that server and the
2335
readwrite one must both define get_url() as resolving to os.getcwd().
2338
def get_vfs_only_server(self):
2339
"""See TestCaseWithMemoryTransport.
2341
This is useful for some tests with specific servers that need
2344
if self.__vfs_server is None:
2345
self.__vfs_server = self.vfs_transport_factory()
2346
self.__vfs_server.setUp()
2347
self.addCleanup(self.__vfs_server.tearDown)
2348
return self.__vfs_server
2350
def make_branch_and_tree(self, relpath, format=None):
2351
"""Create a branch on the transport and a tree locally.
2353
If the transport is not a LocalTransport, the Tree can't be created on
2354
the transport. In that case if the vfs_transport_factory is
2355
LocalURLServer the working tree is created in the local
2356
directory backing the transport, and the returned tree's branch and
2357
repository will also be accessed locally. Otherwise a lightweight
2358
checkout is created and returned.
2360
:param format: The BzrDirFormat.
2361
:returns: the WorkingTree.
2363
# TODO: always use the local disk path for the working tree,
2364
# this obviously requires a format that supports branch references
2365
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2367
b = self.make_branch(relpath, format=format)
2369
return b.bzrdir.create_workingtree()
2370
except errors.NotLocalUrl:
2371
# We can only make working trees locally at the moment. If the
2372
# transport can't support them, then we keep the non-disk-backed
2373
# branch and create a local checkout.
2374
if self.vfs_transport_factory is LocalURLServer:
2375
# the branch is colocated on disk, we cannot create a checkout.
2376
# hopefully callers will expect this.
2377
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2378
wt = local_controldir.create_workingtree()
2379
if wt.branch._format != b._format:
2381
# Make sure that assigning to wt._branch fixes wt.branch,
2382
# in case the implementation details of workingtree objects
2384
self.assertIs(b, wt.branch)
2387
return b.create_checkout(relpath, lightweight=True)
2389
def assertIsDirectory(self, relpath, transport):
2390
"""Assert that relpath within transport is a directory.
2392
This may not be possible on all transports; in that case it propagates
2393
a TransportNotPossible.
2396
mode = transport.stat(relpath).st_mode
2397
except errors.NoSuchFile:
2398
self.fail("path %s is not a directory; no such file"
2400
if not stat.S_ISDIR(mode):
2401
self.fail("path %s is not a directory; has mode %#o"
2404
def assertTreesEqual(self, left, right):
2405
"""Check that left and right have the same content and properties."""
2406
# we use a tree delta to check for equality of the content, and we
2407
# manually check for equality of other things such as the parents list.
2408
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2409
differences = left.changes_from(right)
2410
self.assertFalse(differences.has_changed(),
2411
"Trees %r and %r are different: %r" % (left, right, differences))
2414
super(TestCaseWithTransport, self).setUp()
2415
self.__vfs_server = None
2418
class ChrootedTestCase(TestCaseWithTransport):
2419
"""A support class that provides readonly urls outside the local namespace.
2421
This is done by checking if self.transport_server is a MemoryServer. if it
2422
is then we are chrooted already, if it is not then an HttpServer is used
2425
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2426
be used without needed to redo it when a different
2427
subclass is in use ?
2431
super(ChrootedTestCase, self).setUp()
2432
if not self.vfs_transport_factory == MemoryServer:
2433
self.transport_readonly_server = HttpServer
2436
def condition_id_re(pattern):
2437
"""Create a condition filter which performs a re check on a test's id.
2439
:param pattern: A regular expression string.
2440
:return: A callable that returns True if the re matches.
2442
filter_re = osutils.re_compile_checked(pattern, 0,
2444
def condition(test):
2446
return filter_re.search(test_id)
2450
def condition_isinstance(klass_or_klass_list):
2451
"""Create a condition filter which returns isinstance(param, klass).
2453
:return: A callable which when called with one parameter obj return the
2454
result of isinstance(obj, klass_or_klass_list).
2457
return isinstance(obj, klass_or_klass_list)
2461
def condition_id_in_list(id_list):
2462
"""Create a condition filter which verify that test's id in a list.
2464
:param id_list: A TestIdList object.
2465
:return: A callable that returns True if the test's id appears in the list.
2467
def condition(test):
2468
return id_list.includes(test.id())
2472
def condition_id_startswith(starts):
2473
"""Create a condition filter verifying that test's id starts with a string.
2475
:param starts: A list of string.
2476
:return: A callable that returns True if the test's id starts with one of
2479
def condition(test):
2480
for start in starts:
2481
if test.id().startswith(start):
2487
def exclude_tests_by_condition(suite, condition):
2488
"""Create a test suite which excludes some tests from suite.
2490
:param suite: The suite to get tests from.
2491
:param condition: A callable whose result evaluates True when called with a
2492
test case which should be excluded from the result.
2493
:return: A suite which contains the tests found in suite that fail
2497
for test in iter_suite_tests(suite):
2498
if not condition(test):
2500
return TestUtil.TestSuite(result)
2503
def filter_suite_by_condition(suite, condition):
2504
"""Create a test suite by filtering another one.
2506
:param suite: The source suite.
2507
:param condition: A callable whose result evaluates True when called with a
2508
test case which should be included in the result.
2509
:return: A suite which contains the tests found in suite that pass
2513
for test in iter_suite_tests(suite):
2516
return TestUtil.TestSuite(result)
2519
def filter_suite_by_re(suite, pattern):
2520
"""Create a test suite by filtering another one.
2522
:param suite: the source suite
2523
:param pattern: pattern that names must match
2524
:returns: the newly created suite
2526
condition = condition_id_re(pattern)
2527
result_suite = filter_suite_by_condition(suite, condition)
2531
def filter_suite_by_id_list(suite, test_id_list):
2532
"""Create a test suite by filtering another one.
2534
:param suite: The source suite.
2535
:param test_id_list: A list of the test ids to keep as strings.
2536
:returns: the newly created suite
2538
condition = condition_id_in_list(test_id_list)
2539
result_suite = filter_suite_by_condition(suite, condition)
2543
def filter_suite_by_id_startswith(suite, start):
2544
"""Create a test suite by filtering another one.
2546
:param suite: The source suite.
2547
:param start: A list of string the test id must start with one of.
2548
:returns: the newly created suite
2550
condition = condition_id_startswith(start)
2551
result_suite = filter_suite_by_condition(suite, condition)
2555
def exclude_tests_by_re(suite, pattern):
2556
"""Create a test suite which excludes some tests from suite.
2558
:param suite: The suite to get tests from.
2559
:param pattern: A regular expression string. Test ids that match this
2560
pattern will be excluded from the result.
2561
:return: A TestSuite that contains all the tests from suite without the
2562
tests that matched pattern. The order of tests is the same as it was in
2565
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2568
def preserve_input(something):
2569
"""A helper for performing test suite transformation chains.
2571
:param something: Anything you want to preserve.
2577
def randomize_suite(suite):
2578
"""Return a new TestSuite with suite's tests in random order.
2580
The tests in the input suite are flattened into a single suite in order to
2581
accomplish this. Any nested TestSuites are removed to provide global
2584
tests = list(iter_suite_tests(suite))
2585
random.shuffle(tests)
2586
return TestUtil.TestSuite(tests)
2589
def split_suite_by_condition(suite, condition):
2590
"""Split a test suite into two by a condition.
2592
:param suite: The suite to split.
2593
:param condition: The condition to match on. Tests that match this
2594
condition are returned in the first test suite, ones that do not match
2595
are in the second suite.
2596
:return: A tuple of two test suites, where the first contains tests from
2597
suite matching the condition, and the second contains the remainder
2598
from suite. The order within each output suite is the same as it was in
2603
for test in iter_suite_tests(suite):
2605
matched.append(test)
2607
did_not_match.append(test)
2608
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2611
def split_suite_by_re(suite, pattern):
2612
"""Split a test suite into two by a regular expression.
2614
:param suite: The suite to split.
2615
:param pattern: A regular expression string. Test ids that match this
2616
pattern will be in the first test suite returned, and the others in the
2617
second test suite returned.
2618
:return: A tuple of two test suites, where the first contains tests from
2619
suite matching pattern, and the second contains the remainder from
2620
suite. The order within each output suite is the same as it was in
2623
return split_suite_by_condition(suite, condition_id_re(pattern))
2626
def run_suite(suite, name='test', verbose=False, pattern=".*",
2627
stop_on_failure=False,
2628
transport=None, lsprof_timed=None, bench_history=None,
2629
matching_tests_first=None,
2632
exclude_pattern=None,
2635
suite_decorators=None):
2636
"""Run a test suite for bzr selftest.
2638
:param runner_class: The class of runner to use. Must support the
2639
constructor arguments passed by run_suite which are more than standard
2641
:return: A boolean indicating success.
2643
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2648
if runner_class is None:
2649
runner_class = TextTestRunner
2650
runner = runner_class(stream=sys.stdout,
2652
verbosity=verbosity,
2653
bench_history=bench_history,
2654
list_only=list_only,
2656
runner.stop_on_failure=stop_on_failure
2657
# built in decorator factories:
2659
random_order(random_seed, runner),
2660
exclude_tests(exclude_pattern),
2662
if matching_tests_first:
2663
decorators.append(tests_first(pattern))
2665
decorators.append(filter_tests(pattern))
2666
if suite_decorators:
2667
decorators.extend(suite_decorators)
2668
for decorator in decorators:
2669
suite = decorator(suite)
2670
result = runner.run(suite)
2672
return result.wasStrictlySuccessful()
2674
return result.wasSuccessful()
2677
# A registry where get() returns a suite decorator.
2678
parallel_registry = registry.Registry()
2679
def fork_decorator(suite):
2680
concurrency = local_concurrency()
2681
if concurrency == 1:
2683
from testtools import ConcurrentTestSuite
2684
return ConcurrentTestSuite(suite, fork_for_tests)
2685
parallel_registry.register('fork', fork_decorator)
2686
def subprocess_decorator(suite):
2687
concurrency = local_concurrency()
2688
if concurrency == 1:
2690
from testtools import ConcurrentTestSuite
2691
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2692
parallel_registry.register('subprocess', subprocess_decorator)
2695
def exclude_tests(exclude_pattern):
2696
"""Return a test suite decorator that excludes tests."""
2697
if exclude_pattern is None:
2698
return identity_decorator
2699
def decorator(suite):
2700
return ExcludeDecorator(suite, exclude_pattern)
2704
def filter_tests(pattern):
2706
return identity_decorator
2707
def decorator(suite):
2708
return FilterTestsDecorator(suite, pattern)
2712
def random_order(random_seed, runner):
2713
"""Return a test suite decorator factory for randomising tests order.
2715
:param random_seed: now, a string which casts to a long, or a long.
2716
:param runner: A test runner with a stream attribute to report on.
2718
if random_seed is None:
2719
return identity_decorator
2720
def decorator(suite):
2721
return RandomDecorator(suite, random_seed, runner.stream)
2725
def tests_first(pattern):
2727
return identity_decorator
2728
def decorator(suite):
2729
return TestFirstDecorator(suite, pattern)
2733
def identity_decorator(suite):
2738
class TestDecorator(TestSuite):
2739
"""A decorator for TestCase/TestSuite objects.
2741
Usually, subclasses should override __iter__(used when flattening test
2742
suites), which we do to filter, reorder, parallelise and so on, run() and
2746
def __init__(self, suite):
2747
TestSuite.__init__(self)
2750
def countTestCases(self):
2753
cases += test.countTestCases()
2760
def run(self, result):
2761
# Use iteration on self, not self._tests, to allow subclasses to hook
2764
if result.shouldStop:
2770
class ExcludeDecorator(TestDecorator):
2771
"""A decorator which excludes test matching an exclude pattern."""
2773
def __init__(self, suite, exclude_pattern):
2774
TestDecorator.__init__(self, suite)
2775
self.exclude_pattern = exclude_pattern
2776
self.excluded = False
2780
return iter(self._tests)
2781
self.excluded = True
2782
suite = exclude_tests_by_re(self, self.exclude_pattern)
2784
self.addTests(suite)
2785
return iter(self._tests)
2788
class FilterTestsDecorator(TestDecorator):
2789
"""A decorator which filters tests to those matching a pattern."""
2791
def __init__(self, suite, pattern):
2792
TestDecorator.__init__(self, suite)
2793
self.pattern = pattern
2794
self.filtered = False
2798
return iter(self._tests)
2799
self.filtered = True
2800
suite = filter_suite_by_re(self, self.pattern)
2802
self.addTests(suite)
2803
return iter(self._tests)
2806
class RandomDecorator(TestDecorator):
2807
"""A decorator which randomises the order of its tests."""
2809
def __init__(self, suite, random_seed, stream):
2810
TestDecorator.__init__(self, suite)
2811
self.random_seed = random_seed
2812
self.randomised = False
2813
self.stream = stream
2817
return iter(self._tests)
2818
self.randomised = True
2819
self.stream.writeln("Randomizing test order using seed %s\n" %
2820
(self.actual_seed()))
2821
# Initialise the random number generator.
2822
random.seed(self.actual_seed())
2823
suite = randomize_suite(self)
2825
self.addTests(suite)
2826
return iter(self._tests)
2828
def actual_seed(self):
2829
if self.random_seed == "now":
2830
# We convert the seed to a long to make it reuseable across
2831
# invocations (because the user can reenter it).
2832
self.random_seed = long(time.time())
2834
# Convert the seed to a long if we can
2836
self.random_seed = long(self.random_seed)
2839
return self.random_seed
2842
class TestFirstDecorator(TestDecorator):
2843
"""A decorator which moves named tests to the front."""
2845
def __init__(self, suite, pattern):
2846
TestDecorator.__init__(self, suite)
2847
self.pattern = pattern
2848
self.filtered = False
2852
return iter(self._tests)
2853
self.filtered = True
2854
suites = split_suite_by_re(self, self.pattern)
2856
self.addTests(suites)
2857
return iter(self._tests)
2860
def partition_tests(suite, count):
2861
"""Partition suite into count lists of tests."""
2863
tests = list(iter_suite_tests(suite))
2864
tests_per_process = int(math.ceil(float(len(tests)) / count))
2865
for block in range(count):
2866
low_test = block * tests_per_process
2867
high_test = low_test + tests_per_process
2868
process_tests = tests[low_test:high_test]
2869
result.append(process_tests)
2873
def fork_for_tests(suite):
2874
"""Take suite and start up one runner per CPU by forking()
2876
:return: An iterable of TestCase-like objects which can each have
2877
run(result) called on them to feed tests to result, and
2878
cleanup() called on them to stop them/kill children/end threads.
2880
concurrency = local_concurrency()
2882
from subunit import TestProtocolClient, ProtocolTestCase
2883
class TestInOtherProcess(ProtocolTestCase):
2884
# Should be in subunit, I think. RBC.
2885
def __init__(self, stream, pid):
2886
ProtocolTestCase.__init__(self, stream)
2889
def run(self, result):
2891
ProtocolTestCase.run(self, result)
2893
os.waitpid(self.pid, os.WNOHANG)
2894
# print "pid %d finished" % finished_process
2896
test_blocks = partition_tests(suite, concurrency)
2897
for process_tests in test_blocks:
2898
process_suite = TestSuite()
2899
process_suite.addTests(process_tests)
2900
c2pread, c2pwrite = os.pipe()
2905
# Leave stderr and stdout open so we can see test noise
2906
# Close stdin so that the child goes away if it decides to
2907
# read from stdin (otherwise its a roulette to see what
2908
# child actually gets keystrokes for pdb etc.
2911
stream = os.fdopen(c2pwrite, 'wb', 0)
2912
subunit_result = TestProtocolClient(stream)
2913
process_suite.run(subunit_result)
2918
stream = os.fdopen(c2pread, 'rb', 1)
2919
test = TestInOtherProcess(stream, pid)
2924
def reinvoke_for_tests(suite):
2925
"""Take suite and start up one runner per CPU using subprocess().
2927
:return: An iterable of TestCase-like objects which can each have
2928
run(result) called on them to feed tests to result, and
2929
cleanup() called on them to stop them/kill children/end threads.
2931
concurrency = local_concurrency()
2933
from subunit import TestProtocolClient, ProtocolTestCase
2934
class TestInSubprocess(ProtocolTestCase):
2935
def __init__(self, process, name):
2936
ProtocolTestCase.__init__(self, process.stdout)
2937
self.process = process
2938
self.process.stdin.close()
2941
def run(self, result):
2943
ProtocolTestCase.run(self, result)
2946
os.unlink(self.name)
2947
# print "pid %d finished" % finished_process
2948
test_blocks = partition_tests(suite, concurrency)
2949
for process_tests in test_blocks:
2950
# ugly; currently reimplement rather than reuses TestCase methods.
2951
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2952
if not os.path.isfile(bzr_path):
2953
# We are probably installed. Assume sys.argv is the right file
2954
bzr_path = sys.argv[0]
2955
fd, test_list_file_name = tempfile.mkstemp()
2956
test_list_file = os.fdopen(fd, 'wb', 1)
2957
for test in process_tests:
2958
test_list_file.write(test.id() + '\n')
2959
test_list_file.close()
2961
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
2963
if '--no-plugins' in sys.argv:
2964
argv.append('--no-plugins')
2965
# stderr=STDOUT would be ideal, but until we prevent noise on
2966
# stderr it can interrupt the subunit protocol.
2967
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
2969
test = TestInSubprocess(process, test_list_file_name)
2972
os.unlink(test_list_file_name)
2977
def cpucount(content):
2978
lines = content.splitlines()
2979
prefix = 'processor'
2981
if line.startswith(prefix):
2982
concurrency = int(line[line.find(':')+1:]) + 1
2986
def local_concurrency():
2988
content = file('/proc/cpuinfo', 'rb').read()
2989
concurrency = cpucount(content)
2990
except Exception, e:
2995
class BZRTransformingResult(unittest.TestResult):
2997
def __init__(self, target):
2998
unittest.TestResult.__init__(self)
2999
self.result = target
3001
def startTest(self, test):
3002
self.result.startTest(test)
3004
def stopTest(self, test):
3005
self.result.stopTest(test)
3007
def addError(self, test, err):
3008
feature = self._error_looks_like('UnavailableFeature: ', err)
3009
if feature is not None:
3010
self.result.addNotSupported(test, feature)
3012
self.result.addError(test, err)
3014
def addFailure(self, test, err):
3015
known = self._error_looks_like('KnownFailure: ', err)
3016
if known is not None:
3017
self.result._addKnownFailure(test, [KnownFailure,
3018
KnownFailure(known), None])
3020
self.result.addFailure(test, err)
3022
def addSkip(self, test, reason):
3023
self.result.addSkip(test, reason)
3025
def addSuccess(self, test):
3026
self.result.addSuccess(test)
3028
def _error_looks_like(self, prefix, err):
3029
"""Deserialize exception and returns the stringify value."""
3033
if isinstance(exc, subunit.RemoteException):
3034
# stringify the exception gives access to the remote traceback
3035
# We search the last line for 'prefix'
3036
lines = str(exc).split('\n')
3038
last = lines[-2] # -1 is empty, final \n
3041
if last.startswith(prefix):
3042
value = last[len(prefix):]
3046
# Controlled by "bzr selftest -E=..." option
3047
selftest_debug_flags = set()
3050
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3052
test_suite_factory=None,
3055
matching_tests_first=None,
3058
exclude_pattern=None,
3064
suite_decorators=None,
3066
"""Run the whole test suite under the enhanced runner"""
3067
# XXX: Very ugly way to do this...
3068
# Disable warning about old formats because we don't want it to disturb
3069
# any blackbox tests.
3070
from bzrlib import repository
3071
repository._deprecation_warning_done = True
3073
global default_transport
3074
if transport is None:
3075
transport = default_transport
3076
old_transport = default_transport
3077
default_transport = transport
3078
global selftest_debug_flags
3079
old_debug_flags = selftest_debug_flags
3080
if debug_flags is not None:
3081
selftest_debug_flags = set(debug_flags)
3083
if load_list is None:
3086
keep_only = load_test_id_list(load_list)
3087
if test_suite_factory is None:
3088
suite = test_suite(keep_only, starting_with)
3090
suite = test_suite_factory()
3091
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3092
stop_on_failure=stop_on_failure,
3093
transport=transport,
3094
lsprof_timed=lsprof_timed,
3095
bench_history=bench_history,
3096
matching_tests_first=matching_tests_first,
3097
list_only=list_only,
3098
random_seed=random_seed,
3099
exclude_pattern=exclude_pattern,
3101
runner_class=runner_class,
3102
suite_decorators=suite_decorators,
3105
default_transport = old_transport
3106
selftest_debug_flags = old_debug_flags
3109
def load_test_id_list(file_name):
3110
"""Load a test id list from a text file.
3112
The format is one test id by line. No special care is taken to impose
3113
strict rules, these test ids are used to filter the test suite so a test id
3114
that do not match an existing test will do no harm. This allows user to add
3115
comments, leave blank lines, etc.
3119
ftest = open(file_name, 'rt')
3121
if e.errno != errno.ENOENT:
3124
raise errors.NoSuchFile(file_name)
3126
for test_name in ftest.readlines():
3127
test_list.append(test_name.strip())
3132
def suite_matches_id_list(test_suite, id_list):
3133
"""Warns about tests not appearing or appearing more than once.
3135
:param test_suite: A TestSuite object.
3136
:param test_id_list: The list of test ids that should be found in
3139
:return: (absents, duplicates) absents is a list containing the test found
3140
in id_list but not in test_suite, duplicates is a list containing the
3141
test found multiple times in test_suite.
3143
When using a prefined test id list, it may occurs that some tests do not
3144
exist anymore or that some tests use the same id. This function warns the
3145
tester about potential problems in his workflow (test lists are volatile)
3146
or in the test suite itself (using the same id for several tests does not
3147
help to localize defects).
3149
# Build a dict counting id occurrences
3151
for test in iter_suite_tests(test_suite):
3153
tests[id] = tests.get(id, 0) + 1
3158
occurs = tests.get(id, 0)
3160
not_found.append(id)
3162
duplicates.append(id)
3164
return not_found, duplicates
3167
class TestIdList(object):
3168
"""Test id list to filter a test suite.
3170
Relying on the assumption that test ids are built as:
3171
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3172
notation, this class offers methods to :
3173
- avoid building a test suite for modules not refered to in the test list,
3174
- keep only the tests listed from the module test suite.
3177
def __init__(self, test_id_list):
3178
# When a test suite needs to be filtered against us we compare test ids
3179
# for equality, so a simple dict offers a quick and simple solution.
3180
self.tests = dict().fromkeys(test_id_list, True)
3182
# While unittest.TestCase have ids like:
3183
# <module>.<class>.<method>[(<param+)],
3184
# doctest.DocTestCase can have ids like:
3187
# <module>.<function>
3188
# <module>.<class>.<method>
3190
# Since we can't predict a test class from its name only, we settle on
3191
# a simple constraint: a test id always begins with its module name.
3194
for test_id in test_id_list:
3195
parts = test_id.split('.')
3196
mod_name = parts.pop(0)
3197
modules[mod_name] = True
3199
mod_name += '.' + part
3200
modules[mod_name] = True
3201
self.modules = modules
3203
def refers_to(self, module_name):
3204
"""Is there tests for the module or one of its sub modules."""
3205
return self.modules.has_key(module_name)
3207
def includes(self, test_id):
3208
return self.tests.has_key(test_id)
3211
class TestPrefixAliasRegistry(registry.Registry):
3212
"""A registry for test prefix aliases.
3214
This helps implement shorcuts for the --starting-with selftest
3215
option. Overriding existing prefixes is not allowed but not fatal (a
3216
warning will be emitted).
3219
def register(self, key, obj, help=None, info=None,
3220
override_existing=False):
3221
"""See Registry.register.
3223
Trying to override an existing alias causes a warning to be emitted,
3224
not a fatal execption.
3227
super(TestPrefixAliasRegistry, self).register(
3228
key, obj, help=help, info=info, override_existing=False)
3230
actual = self.get(key)
3231
note('Test prefix alias %s is already used for %s, ignoring %s'
3232
% (key, actual, obj))
3234
def resolve_alias(self, id_start):
3235
"""Replace the alias by the prefix in the given string.
3237
Using an unknown prefix is an error to help catching typos.
3239
parts = id_start.split('.')
3241
parts[0] = self.get(parts[0])
3243
raise errors.BzrCommandError(
3244
'%s is not a known test prefix alias' % parts[0])
3245
return '.'.join(parts)
3248
test_prefix_alias_registry = TestPrefixAliasRegistry()
3249
"""Registry of test prefix aliases."""
3252
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3253
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3254
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3256
# Obvious higest levels prefixes, feel free to add your own via a plugin
3257
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3258
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3259
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3260
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3261
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3264
def test_suite(keep_only=None, starting_with=None):
3265
"""Build and return TestSuite for the whole of bzrlib.
3267
:param keep_only: A list of test ids limiting the suite returned.
3269
:param starting_with: An id limiting the suite returned to the tests
3272
This function can be replaced if you need to change the default test
3273
suite on a global basis, but it is not encouraged.
3277
'bzrlib.tests.blackbox',
3278
'bzrlib.tests.branch_implementations',
3279
'bzrlib.tests.bzrdir_implementations',
3280
'bzrlib.tests.commands',
3281
'bzrlib.tests.interrepository_implementations',
3282
'bzrlib.tests.intertree_implementations',
3283
'bzrlib.tests.inventory_implementations',
3284
'bzrlib.tests.per_interbranch',
3285
'bzrlib.tests.per_lock',
3286
'bzrlib.tests.per_repository',
3287
'bzrlib.tests.per_repository_reference',
3288
'bzrlib.tests.test__dirstate_helpers',
3289
'bzrlib.tests.test__walkdirs_win32',
3290
'bzrlib.tests.test_ancestry',
3291
'bzrlib.tests.test_annotate',
3292
'bzrlib.tests.test_api',
3293
'bzrlib.tests.test_atomicfile',
3294
'bzrlib.tests.test_bad_files',
3295
'bzrlib.tests.test_bisect_multi',
3296
'bzrlib.tests.test_branch',
3297
'bzrlib.tests.test_branchbuilder',
3298
'bzrlib.tests.test_btree_index',
3299
'bzrlib.tests.test_bugtracker',
3300
'bzrlib.tests.test_bundle',
3301
'bzrlib.tests.test_bzrdir',
3302
'bzrlib.tests.test_cache_utf8',
3303
'bzrlib.tests.test_clean_tree',
3304
'bzrlib.tests.test_chunk_writer',
3305
'bzrlib.tests.test__chunks_to_lines',
3306
'bzrlib.tests.test_commands',
3307
'bzrlib.tests.test_commit',
3308
'bzrlib.tests.test_commit_merge',
3309
'bzrlib.tests.test_config',
3310
'bzrlib.tests.test_conflicts',
3311
'bzrlib.tests.test_counted_lock',
3312
'bzrlib.tests.test_decorators',
3313
'bzrlib.tests.test_delta',
3314
'bzrlib.tests.test_debug',
3315
'bzrlib.tests.test_deprecated_graph',
3316
'bzrlib.tests.test_diff',
3317
'bzrlib.tests.test_directory_service',
3318
'bzrlib.tests.test_dirstate',
3319
'bzrlib.tests.test_email_message',
3320
'bzrlib.tests.test_errors',
3321
'bzrlib.tests.test_export',
3322
'bzrlib.tests.test_extract',
3323
'bzrlib.tests.test_fetch',
3324
'bzrlib.tests.test_fifo_cache',
3325
'bzrlib.tests.test_filters',
3326
'bzrlib.tests.test_ftp_transport',
3327
'bzrlib.tests.test_foreign',
3328
'bzrlib.tests.test_generate_docs',
3329
'bzrlib.tests.test_generate_ids',
3330
'bzrlib.tests.test_globbing',
3331
'bzrlib.tests.test_gpg',
3332
'bzrlib.tests.test_graph',
3333
'bzrlib.tests.test_hashcache',
3334
'bzrlib.tests.test_help',
3335
'bzrlib.tests.test_hooks',
3336
'bzrlib.tests.test_http',
3337
'bzrlib.tests.test_http_implementations',
3338
'bzrlib.tests.test_http_response',
3339
'bzrlib.tests.test_https_ca_bundle',
3340
'bzrlib.tests.test_identitymap',
3341
'bzrlib.tests.test_ignores',
3342
'bzrlib.tests.test_index',
3343
'bzrlib.tests.test_info',
3344
'bzrlib.tests.test_inv',
3345
'bzrlib.tests.test_knit',
3346
'bzrlib.tests.test_lazy_import',
3347
'bzrlib.tests.test_lazy_regex',
3348
'bzrlib.tests.test_lockable_files',
3349
'bzrlib.tests.test_lockdir',
3350
'bzrlib.tests.test_log',
3351
'bzrlib.tests.test_lru_cache',
3352
'bzrlib.tests.test_lsprof',
3353
'bzrlib.tests.test_mail_client',
3354
'bzrlib.tests.test_memorytree',
3355
'bzrlib.tests.test_merge',
3356
'bzrlib.tests.test_merge3',
3357
'bzrlib.tests.test_merge_core',
3358
'bzrlib.tests.test_merge_directive',
3359
'bzrlib.tests.test_missing',
3360
'bzrlib.tests.test_msgeditor',
3361
'bzrlib.tests.test_multiparent',
3362
'bzrlib.tests.test_mutabletree',
3363
'bzrlib.tests.test_nonascii',
3364
'bzrlib.tests.test_options',
3365
'bzrlib.tests.test_osutils',
3366
'bzrlib.tests.test_osutils_encodings',
3367
'bzrlib.tests.test_pack',
3368
'bzrlib.tests.test_pack_repository',
3369
'bzrlib.tests.test_patch',
3370
'bzrlib.tests.test_patches',
3371
'bzrlib.tests.test_permissions',
3372
'bzrlib.tests.test_plugins',
3373
'bzrlib.tests.test_progress',
3374
'bzrlib.tests.test_read_bundle',
3375
'bzrlib.tests.test_reconcile',
3376
'bzrlib.tests.test_reconfigure',
3377
'bzrlib.tests.test_registry',
3378
'bzrlib.tests.test_remote',
3379
'bzrlib.tests.test_rename_map',
3380
'bzrlib.tests.test_repository',
3381
'bzrlib.tests.test_revert',
3382
'bzrlib.tests.test_revision',
3383
'bzrlib.tests.test_revisionspec',
3384
'bzrlib.tests.test_revisiontree',
3385
'bzrlib.tests.test_rio',
3386
'bzrlib.tests.test_rules',
3387
'bzrlib.tests.test_sampler',
3388
'bzrlib.tests.test_selftest',
3389
'bzrlib.tests.test_setup',
3390
'bzrlib.tests.test_sftp_transport',
3391
'bzrlib.tests.test_shelf',
3392
'bzrlib.tests.test_shelf_ui',
3393
'bzrlib.tests.test_smart',
3394
'bzrlib.tests.test_smart_add',
3395
'bzrlib.tests.test_smart_request',
3396
'bzrlib.tests.test_smart_transport',
3397
'bzrlib.tests.test_smtp_connection',
3398
'bzrlib.tests.test_source',
3399
'bzrlib.tests.test_ssh_transport',
3400
'bzrlib.tests.test_status',
3401
'bzrlib.tests.test_store',
3402
'bzrlib.tests.test_strace',
3403
'bzrlib.tests.test_subsume',
3404
'bzrlib.tests.test_switch',
3405
'bzrlib.tests.test_symbol_versioning',
3406
'bzrlib.tests.test_tag',
3407
'bzrlib.tests.test_testament',
3408
'bzrlib.tests.test_textfile',
3409
'bzrlib.tests.test_textmerge',
3410
'bzrlib.tests.test_timestamp',
3411
'bzrlib.tests.test_trace',
3412
'bzrlib.tests.test_transactions',
3413
'bzrlib.tests.test_transform',
3414
'bzrlib.tests.test_transport',
3415
'bzrlib.tests.test_transport_implementations',
3416
'bzrlib.tests.test_transport_log',
3417
'bzrlib.tests.test_tree',
3418
'bzrlib.tests.test_treebuilder',
3419
'bzrlib.tests.test_tsort',
3420
'bzrlib.tests.test_tuned_gzip',
3421
'bzrlib.tests.test_ui',
3422
'bzrlib.tests.test_uncommit',
3423
'bzrlib.tests.test_upgrade',
3424
'bzrlib.tests.test_upgrade_stacked',
3425
'bzrlib.tests.test_urlutils',
3426
'bzrlib.tests.test_version',
3427
'bzrlib.tests.test_version_info',
3428
'bzrlib.tests.test_versionedfile',
3429
'bzrlib.tests.test_weave',
3430
'bzrlib.tests.test_whitebox',
3431
'bzrlib.tests.test_win32utils',
3432
'bzrlib.tests.test_workingtree',
3433
'bzrlib.tests.test_workingtree_4',
3434
'bzrlib.tests.test_wsgi',
3435
'bzrlib.tests.test_xml',
3436
'bzrlib.tests.tree_implementations',
3437
'bzrlib.tests.workingtree_implementations',
3438
'bzrlib.util.tests.test_bencode',
3441
loader = TestUtil.TestLoader()
3444
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3445
for start in starting_with]
3446
# We take precedence over keep_only because *at loading time* using
3447
# both options means we will load less tests for the same final result.
3448
def interesting_module(name):
3449
for start in starting_with:
3451
# Either the module name starts with the specified string
3452
name.startswith(start)
3453
# or it may contain tests starting with the specified string
3454
or start.startswith(name)
3458
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3460
elif keep_only is not None:
3461
id_filter = TestIdList(keep_only)
3462
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3463
def interesting_module(name):
3464
return id_filter.refers_to(name)
3467
loader = TestUtil.TestLoader()
3468
def interesting_module(name):
3469
# No filtering, all modules are interesting
3472
suite = loader.suiteClass()
3474
# modules building their suite with loadTestsFromModuleNames
3475
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3477
modules_to_doctest = [
3479
'bzrlib.branchbuilder',
3482
'bzrlib.iterablefile',
3486
'bzrlib.symbol_versioning',
3489
'bzrlib.version_info_formats.format_custom',
3492
for mod in modules_to_doctest:
3493
if not interesting_module(mod):
3494
# No tests to keep here, move along
3497
# note that this really does mean "report only" -- doctest
3498
# still runs the rest of the examples
3499
doc_suite = doctest.DocTestSuite(mod,
3500
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3501
except ValueError, e:
3502
print '**failed to get doctest for: %s\n%s' % (mod, e)
3504
if len(doc_suite._tests) == 0:
3505
raise errors.BzrError("no doctests found in %s" % (mod,))
3506
suite.addTest(doc_suite)
3508
default_encoding = sys.getdefaultencoding()
3509
for name, plugin in bzrlib.plugin.plugins().items():
3510
if not interesting_module(plugin.module.__name__):
3512
plugin_suite = plugin.test_suite()
3513
# We used to catch ImportError here and turn it into just a warning,
3514
# but really if you don't have --no-plugins this should be a failure.
3515
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3516
if plugin_suite is None:
3517
plugin_suite = plugin.load_plugin_tests(loader)
3518
if plugin_suite is not None:
3519
suite.addTest(plugin_suite)
3520
if default_encoding != sys.getdefaultencoding():
3521
bzrlib.trace.warning(
3522
'Plugin "%s" tried to reset default encoding to: %s', name,
3523
sys.getdefaultencoding())
3525
sys.setdefaultencoding(default_encoding)
3528
suite = filter_suite_by_id_startswith(suite, starting_with)
3530
if keep_only is not None:
3531
# Now that the referred modules have loaded their tests, keep only the
3533
suite = filter_suite_by_id_list(suite, id_filter)
3534
# Do some sanity checks on the id_list filtering
3535
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3537
# The tester has used both keep_only and starting_with, so he is
3538
# already aware that some tests are excluded from the list, there
3539
# is no need to tell him which.
3542
# Some tests mentioned in the list are not in the test suite. The
3543
# list may be out of date, report to the tester.
3544
for id in not_found:
3545
bzrlib.trace.warning('"%s" not found in the test suite', id)
3546
for id in duplicates:
3547
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3552
def multiply_scenarios(scenarios_left, scenarios_right):
3553
"""Multiply two sets of scenarios.
3555
:returns: the cartesian product of the two sets of scenarios, that is
3556
a scenario for every possible combination of a left scenario and a
3560
('%s,%s' % (left_name, right_name),
3561
dict(left_dict.items() + right_dict.items()))
3562
for left_name, left_dict in scenarios_left
3563
for right_name, right_dict in scenarios_right]
3566
def multiply_tests(tests, scenarios, result):
3567
"""Multiply tests_list by scenarios into result.
3569
This is the core workhorse for test parameterisation.
3571
Typically the load_tests() method for a per-implementation test suite will
3572
call multiply_tests and return the result.
3574
:param tests: The tests to parameterise.
3575
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3576
scenario_param_dict).
3577
:param result: A TestSuite to add created tests to.
3579
This returns the passed in result TestSuite with the cross product of all
3580
the tests repeated once for each scenario. Each test is adapted by adding
3581
the scenario name at the end of its id(), and updating the test object's
3582
__dict__ with the scenario_param_dict.
3584
>>> r = multiply_tests(
3585
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3586
... [('one', dict(param=1)),
3587
... ('two', dict(param=2))],
3589
>>> tests = list(iter_suite_tests(r))
3593
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3599
for test in iter_suite_tests(tests):
3600
apply_scenarios(test, scenarios, result)
3604
def apply_scenarios(test, scenarios, result):
3605
"""Apply the scenarios in scenarios to test and add to result.
3607
:param test: The test to apply scenarios to.
3608
:param scenarios: An iterable of scenarios to apply to test.
3610
:seealso: apply_scenario
3612
for scenario in scenarios:
3613
result.addTest(apply_scenario(test, scenario))
3617
def apply_scenario(test, scenario):
3618
"""Copy test and apply scenario to it.
3620
:param test: A test to adapt.
3621
:param scenario: A tuple describing the scenarion.
3622
The first element of the tuple is the new test id.
3623
The second element is a dict containing attributes to set on the
3625
:return: The adapted test.
3627
new_id = "%s(%s)" % (test.id(), scenario[0])
3628
new_test = clone_test(test, new_id)
3629
for name, value in scenario[1].items():
3630
setattr(new_test, name, value)
3634
def clone_test(test, new_id):
3635
"""Clone a test giving it a new id.
3637
:param test: The test to clone.
3638
:param new_id: The id to assign to it.
3639
:return: The new test.
3641
from copy import deepcopy
3642
new_test = deepcopy(test)
3643
new_test.id = lambda: new_id
3647
def _rmtree_temp_dir(dirname):
3648
# If LANG=C we probably have created some bogus paths
3649
# which rmtree(unicode) will fail to delete
3650
# so make sure we are using rmtree(str) to delete everything
3651
# except on win32, where rmtree(str) will fail
3652
# since it doesn't have the property of byte-stream paths
3653
# (they are either ascii or mbcs)
3654
if sys.platform == 'win32':
3655
# make sure we are using the unicode win32 api
3656
dirname = unicode(dirname)
3658
dirname = dirname.encode(sys.getfilesystemencoding())
3660
osutils.rmtree(dirname)
3662
if sys.platform == 'win32' and e.errno == errno.EACCES:
3663
sys.stderr.write(('Permission denied: '
3664
'unable to remove testing dir '
3665
'%s\n' % os.path.basename(dirname)))
3670
class Feature(object):
3671
"""An operating system Feature."""
3674
self._available = None
3676
def available(self):
3677
"""Is the feature available?
3679
:return: True if the feature is available.
3681
if self._available is None:
3682
self._available = self._probe()
3683
return self._available
3686
"""Implement this method in concrete features.
3688
:return: True if the feature is available.
3690
raise NotImplementedError
3693
if getattr(self, 'feature_name', None):
3694
return self.feature_name()
3695
return self.__class__.__name__
3698
class _SymlinkFeature(Feature):
3701
return osutils.has_symlinks()
3703
def feature_name(self):
3706
SymlinkFeature = _SymlinkFeature()
3709
class _HardlinkFeature(Feature):
3712
return osutils.has_hardlinks()
3714
def feature_name(self):
3717
HardlinkFeature = _HardlinkFeature()
3720
class _OsFifoFeature(Feature):
3723
return getattr(os, 'mkfifo', None)
3725
def feature_name(self):
3726
return 'filesystem fifos'
3728
OsFifoFeature = _OsFifoFeature()
3731
class _UnicodeFilenameFeature(Feature):
3732
"""Does the filesystem support Unicode filenames?"""
3736
# Check for character combinations unlikely to be covered by any
3737
# single non-unicode encoding. We use the characters
3738
# - greek small letter alpha (U+03B1) and
3739
# - braille pattern dots-123456 (U+283F).
3740
os.stat(u'\u03b1\u283f')
3741
except UnicodeEncodeError:
3743
except (IOError, OSError):
3744
# The filesystem allows the Unicode filename but the file doesn't
3748
# The filesystem allows the Unicode filename and the file exists,
3752
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3755
def probe_unicode_in_user_encoding():
3756
"""Try to encode several unicode strings to use in unicode-aware tests.
3757
Return first successfull match.
3759
:return: (unicode value, encoded plain string value) or (None, None)
3761
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3762
for uni_val in possible_vals:
3764
str_val = uni_val.encode(osutils.get_user_encoding())
3765
except UnicodeEncodeError:
3766
# Try a different character
3769
return uni_val, str_val
3773
def probe_bad_non_ascii(encoding):
3774
"""Try to find [bad] character with code [128..255]
3775
that cannot be decoded to unicode in some encoding.
3776
Return None if all non-ascii characters is valid
3779
for i in xrange(128, 256):
3782
char.decode(encoding)
3783
except UnicodeDecodeError:
3788
class _HTTPSServerFeature(Feature):
3789
"""Some tests want an https Server, check if one is available.
3791
Right now, the only way this is available is under python2.6 which provides
3802
def feature_name(self):
3803
return 'HTTPSServer'
3806
HTTPSServerFeature = _HTTPSServerFeature()
3809
class _UnicodeFilename(Feature):
3810
"""Does the filesystem support Unicode filenames?"""
3815
except UnicodeEncodeError:
3817
except (IOError, OSError):
3818
# The filesystem allows the Unicode filename but the file doesn't
3822
# The filesystem allows the Unicode filename and the file exists,
3826
UnicodeFilename = _UnicodeFilename()
3829
class _UTF8Filesystem(Feature):
3830
"""Is the filesystem UTF-8?"""
3833
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3837
UTF8Filesystem = _UTF8Filesystem()
3840
class _CaseInsCasePresFilenameFeature(Feature):
3841
"""Is the file-system case insensitive, but case-preserving?"""
3844
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3846
# first check truly case-preserving for created files, then check
3847
# case insensitive when opening existing files.
3848
name = osutils.normpath(name)
3849
base, rel = osutils.split(name)
3850
found_rel = osutils.canonical_relpath(base, name)
3851
return (found_rel == rel
3852
and os.path.isfile(name.upper())
3853
and os.path.isfile(name.lower()))
3858
def feature_name(self):
3859
return "case-insensitive case-preserving filesystem"
3861
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3864
class _CaseInsensitiveFilesystemFeature(Feature):
3865
"""Check if underlying filesystem is case-insensitive but *not* case
3868
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3869
# more likely to be case preserving, so this case is rare.
3872
if CaseInsCasePresFilenameFeature.available():
3875
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3876
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3877
TestCaseWithMemoryTransport.TEST_ROOT = root
3879
root = TestCaseWithMemoryTransport.TEST_ROOT
3880
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3882
name_a = osutils.pathjoin(tdir, 'a')
3883
name_A = osutils.pathjoin(tdir, 'A')
3885
result = osutils.isdir(name_A)
3886
_rmtree_temp_dir(tdir)
3889
def feature_name(self):
3890
return 'case-insensitive filesystem'
3892
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3895
class _SubUnitFeature(Feature):
3896
"""Check if subunit is available."""
3905
def feature_name(self):
3908
SubUnitFeature = _SubUnitFeature()
3909
# Only define SubUnitBzrRunner if subunit is available.
3911
from subunit import TestProtocolClient
3912
class SubUnitBzrRunner(TextTestRunner):
3913
def run(self, test):
3914
# undo out claim for testing which looks like a test start to subunit
3915
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3916
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
