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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
37
from pprint import pformat
42
from subprocess import Popen, PIPE
66
import bzrlib.commands
67
import bzrlib.timestamp
69
import bzrlib.inventory
70
import bzrlib.iterablefile
75
# lsprof not available
77
from bzrlib.merge import merge_inner
80
from bzrlib.smart import client, server
82
from bzrlib import symbol_versioning
83
from bzrlib.symbol_versioning import (
90
from bzrlib.transport import get_transport
91
import bzrlib.transport
92
from bzrlib.transport.local import LocalURLServer
93
from bzrlib.transport.memory import MemoryServer
94
from bzrlib.transport.readonly import ReadonlyServer
95
from bzrlib.trace import mutter, note
96
from bzrlib.tests import TestUtil
97
from bzrlib.tests.http_server import HttpServer
98
from bzrlib.tests.TestUtil import (
102
from bzrlib.tests.treeshape import build_tree_contents
103
import bzrlib.version_info_formats.format_custom
104
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
106
# Mark this python module as being part of the implementation
107
# of unittest: this gives us better tracebacks where the last
108
# shown frame is the test code, not our assertXYZ.
111
default_transport = LocalURLServer
114
class ExtendedTestResult(unittest._TextTestResult):
115
"""Accepts, reports and accumulates the results of running tests.
117
Compared to the unittest version this class adds support for
118
profiling, benchmarking, stopping as soon as a test fails, and
119
skipping tests. There are further-specialized subclasses for
120
different types of display.
122
When a test finishes, in whatever way, it calls one of the addSuccess,
123
addFailure or addError classes. These in turn may redirect to a more
124
specific case for the special test results supported by our extended
127
Note that just one of these objects is fed the results from many tests.
132
def __init__(self, stream, descriptions, verbosity,
136
"""Construct new TestResult.
138
:param bench_history: Optionally, a writable file object to accumulate
141
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
142
if bench_history is not None:
143
from bzrlib.version import _get_bzr_source_tree
144
src_tree = _get_bzr_source_tree()
147
revision_id = src_tree.get_parent_ids()[0]
149
# XXX: if this is a brand new tree, do the same as if there
153
# XXX: If there's no branch, what should we do?
155
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
156
self._bench_history = bench_history
157
self.ui = ui.ui_factory
158
self.num_tests = num_tests
160
self.failure_count = 0
161
self.known_failure_count = 0
163
self.not_applicable_count = 0
164
self.unsupported = {}
166
self._overall_start_time = time.time()
168
def _extractBenchmarkTime(self, testCase):
169
"""Add a benchmark time for the current test case."""
170
return getattr(testCase, "_benchtime", None)
172
def _elapsedTestTimeString(self):
173
"""Return a time string for the overall time the current test has taken."""
174
return self._formatTime(time.time() - self._start_time)
176
def _testTimeString(self, testCase):
177
benchmark_time = self._extractBenchmarkTime(testCase)
178
if benchmark_time is not None:
180
self._formatTime(benchmark_time),
181
self._elapsedTestTimeString())
183
return " %s" % self._elapsedTestTimeString()
185
def _formatTime(self, seconds):
186
"""Format seconds as milliseconds with leading spaces."""
187
# some benchmarks can take thousands of seconds to run, so we need 8
189
return "%8dms" % (1000 * seconds)
191
def _shortened_test_description(self, test):
193
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
196
def startTest(self, test):
197
unittest.TestResult.startTest(self, test)
198
self.report_test_start(test)
199
test.number = self.count
200
self._recordTestStartTime()
202
def _recordTestStartTime(self):
203
"""Record that a test has started."""
204
self._start_time = time.time()
206
def _cleanupLogFile(self, test):
207
# We can only do this if we have one of our TestCases, not if
209
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
210
if setKeepLogfile is not None:
213
def addError(self, test, err):
214
"""Tell result that test finished with an error.
216
Called from the TestCase run() method when the test
217
fails with an unexpected error.
219
self._testConcluded(test)
220
if isinstance(err[1], TestNotApplicable):
221
return self._addNotApplicable(test, err)
222
elif isinstance(err[1], UnavailableFeature):
223
return self.addNotSupported(test, err[1].args[0])
225
unittest.TestResult.addError(self, test, err)
226
self.error_count += 1
227
self.report_error(test, err)
230
self._cleanupLogFile(test)
232
def addFailure(self, test, err):
233
"""Tell result that test failed.
235
Called from the TestCase run() method when the test
236
fails because e.g. an assert() method failed.
238
self._testConcluded(test)
239
if isinstance(err[1], KnownFailure):
240
return self._addKnownFailure(test, err)
242
unittest.TestResult.addFailure(self, test, err)
243
self.failure_count += 1
244
self.report_failure(test, err)
247
self._cleanupLogFile(test)
249
def addSuccess(self, test):
250
"""Tell result that test completed successfully.
252
Called from the TestCase run()
254
self._testConcluded(test)
255
if self._bench_history is not None:
256
benchmark_time = self._extractBenchmarkTime(test)
257
if benchmark_time is not None:
258
self._bench_history.write("%s %s\n" % (
259
self._formatTime(benchmark_time),
261
self.report_success(test)
262
self._cleanupLogFile(test)
263
unittest.TestResult.addSuccess(self, test)
264
test._log_contents = ''
266
def _testConcluded(self, test):
267
"""Common code when a test has finished.
269
Called regardless of whether it succeded, failed, etc.
273
def _addKnownFailure(self, test, err):
274
self.known_failure_count += 1
275
self.report_known_failure(test, err)
277
def addNotSupported(self, test, feature):
278
"""The test will not be run because of a missing feature.
280
# this can be called in two different ways: it may be that the
281
# test started running, and then raised (through addError)
282
# UnavailableFeature. Alternatively this method can be called
283
# while probing for features before running the tests; in that
284
# case we will see startTest and stopTest, but the test will never
286
self.unsupported.setdefault(str(feature), 0)
287
self.unsupported[str(feature)] += 1
288
self.report_unsupported(test, feature)
290
def addSkip(self, test, reason):
291
"""A test has not run for 'reason'."""
293
self.report_skip(test, reason)
295
def _addNotApplicable(self, test, skip_excinfo):
296
if isinstance(skip_excinfo[1], TestNotApplicable):
297
self.not_applicable_count += 1
298
self.report_not_applicable(test, skip_excinfo)
301
except KeyboardInterrupt:
304
self.addError(test, test.exc_info())
306
# seems best to treat this as success from point-of-view of unittest
307
# -- it actually does nothing so it barely matters :)
308
unittest.TestResult.addSuccess(self, test)
309
test._log_contents = ''
311
def printErrorList(self, flavour, errors):
312
for test, err in errors:
313
self.stream.writeln(self.separator1)
314
self.stream.write("%s: " % flavour)
315
self.stream.writeln(self.getDescription(test))
316
if getattr(test, '_get_log', None) is not None:
317
self.stream.write('\n')
319
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
321
self.stream.write(test._get_log())
322
self.stream.write('\n')
324
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
325
self.stream.write('\n')
326
self.stream.writeln(self.separator2)
327
self.stream.writeln("%s" % err)
332
def report_cleaning_up(self):
335
def report_success(self, test):
338
def wasStrictlySuccessful(self):
339
if self.unsupported or self.known_failure_count:
341
return self.wasSuccessful()
344
class TextTestResult(ExtendedTestResult):
345
"""Displays progress and results of tests in text form"""
347
def __init__(self, stream, descriptions, verbosity,
352
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
353
bench_history, num_tests)
355
self.pb = self.ui.nested_progress_bar()
356
self._supplied_pb = False
359
self._supplied_pb = True
360
self.pb.show_pct = False
361
self.pb.show_spinner = False
362
self.pb.show_eta = False,
363
self.pb.show_count = False
364
self.pb.show_bar = False
366
def report_starting(self):
367
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
369
def _progress_prefix_text(self):
370
# the longer this text, the less space we have to show the test
372
a = '[%d' % self.count # total that have been run
373
# tests skipped as known not to be relevant are not important enough
375
## if self.skip_count:
376
## a += ', %d skip' % self.skip_count
377
## if self.known_failure_count:
378
## a += '+%dX' % self.known_failure_count
379
if self.num_tests is not None:
380
a +='/%d' % self.num_tests
382
runtime = time.time() - self._overall_start_time
384
a += '%dm%ds' % (runtime / 60, runtime % 60)
388
a += ', %d err' % self.error_count
389
if self.failure_count:
390
a += ', %d fail' % self.failure_count
392
a += ', %d missing' % len(self.unsupported)
396
def report_test_start(self, test):
399
self._progress_prefix_text()
401
+ self._shortened_test_description(test))
403
def _test_description(self, test):
404
return self._shortened_test_description(test)
406
def report_error(self, test, err):
407
self.pb.note('ERROR: %s\n %s\n',
408
self._test_description(test),
412
def report_failure(self, test, err):
413
self.pb.note('FAIL: %s\n %s\n',
414
self._test_description(test),
418
def report_known_failure(self, test, err):
419
self.pb.note('XFAIL: %s\n%s\n',
420
self._test_description(test), err[1])
422
def report_skip(self, test, reason):
425
def report_not_applicable(self, test, skip_excinfo):
428
def report_unsupported(self, test, feature):
429
"""test cannot be run because feature is missing."""
431
def report_cleaning_up(self):
432
self.pb.update('Cleaning up')
435
if not self._supplied_pb:
439
class VerboseTestResult(ExtendedTestResult):
440
"""Produce long output, with one line per test run plus times"""
442
def _ellipsize_to_right(self, a_string, final_width):
443
"""Truncate and pad a string, keeping the right hand side"""
444
if len(a_string) > final_width:
445
result = '...' + a_string[3-final_width:]
448
return result.ljust(final_width)
450
def report_starting(self):
451
self.stream.write('running %d tests...\n' % self.num_tests)
453
def report_test_start(self, test):
455
name = self._shortened_test_description(test)
456
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
457
# numbers, plus a trailing blank
458
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
459
self.stream.write(self._ellipsize_to_right(name,
460
osutils.terminal_width()-30))
463
def _error_summary(self, err):
465
return '%s%s' % (indent, err[1])
467
def report_error(self, test, err):
468
self.stream.writeln('ERROR %s\n%s'
469
% (self._testTimeString(test),
470
self._error_summary(err)))
472
def report_failure(self, test, err):
473
self.stream.writeln(' FAIL %s\n%s'
474
% (self._testTimeString(test),
475
self._error_summary(err)))
477
def report_known_failure(self, test, err):
478
self.stream.writeln('XFAIL %s\n%s'
479
% (self._testTimeString(test),
480
self._error_summary(err)))
482
def report_success(self, test):
483
self.stream.writeln(' OK %s' % self._testTimeString(test))
484
for bench_called, stats in getattr(test, '_benchcalls', []):
485
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
486
stats.pprint(file=self.stream)
487
# flush the stream so that we get smooth output. This verbose mode is
488
# used to show the output in PQM.
491
def report_skip(self, test, reason):
492
self.stream.writeln(' SKIP %s\n%s'
493
% (self._testTimeString(test), reason))
495
def report_not_applicable(self, test, skip_excinfo):
496
self.stream.writeln(' N/A %s\n%s'
497
% (self._testTimeString(test),
498
self._error_summary(skip_excinfo)))
500
def report_unsupported(self, test, feature):
501
"""test cannot be run because feature is missing."""
502
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
503
%(self._testTimeString(test), feature))
506
class TextTestRunner(object):
507
stop_on_failure = False
516
self.stream = unittest._WritelnDecorator(stream)
517
self.descriptions = descriptions
518
self.verbosity = verbosity
519
self._bench_history = bench_history
520
self.list_only = list_only
523
"Run the given test case or test suite."
524
startTime = time.time()
525
if self.verbosity == 1:
526
result_class = TextTestResult
527
elif self.verbosity >= 2:
528
result_class = VerboseTestResult
529
result = result_class(self.stream,
532
bench_history=self._bench_history,
533
num_tests=test.countTestCases(),
535
result.stop_early = self.stop_on_failure
536
result.report_starting()
538
if self.verbosity >= 2:
539
self.stream.writeln("Listing tests only ...\n")
541
for t in iter_suite_tests(test):
542
self.stream.writeln("%s" % (t.id()))
544
actionTaken = "Listed"
547
run = result.testsRun
549
stopTime = time.time()
550
timeTaken = stopTime - startTime
552
self.stream.writeln(result.separator2)
553
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
554
run, run != 1 and "s" or "", timeTaken))
555
self.stream.writeln()
556
if not result.wasSuccessful():
557
self.stream.write("FAILED (")
558
failed, errored = map(len, (result.failures, result.errors))
560
self.stream.write("failures=%d" % failed)
562
if failed: self.stream.write(", ")
563
self.stream.write("errors=%d" % errored)
564
if result.known_failure_count:
565
if failed or errored: self.stream.write(", ")
566
self.stream.write("known_failure_count=%d" %
567
result.known_failure_count)
568
self.stream.writeln(")")
570
if result.known_failure_count:
571
self.stream.writeln("OK (known_failures=%d)" %
572
result.known_failure_count)
574
self.stream.writeln("OK")
575
if result.skip_count > 0:
576
skipped = result.skip_count
577
self.stream.writeln('%d test%s skipped' %
578
(skipped, skipped != 1 and "s" or ""))
579
if result.unsupported:
580
for feature, count in sorted(result.unsupported.items()):
581
self.stream.writeln("Missing feature '%s' skipped %d tests." %
587
def iter_suite_tests(suite):
588
"""Return all tests in a suite, recursing through nested suites"""
589
if isinstance(suite, unittest.TestCase):
591
elif isinstance(suite, unittest.TestSuite):
592
for item in suite._tests:
593
for r in iter_suite_tests(item):
596
raise Exception('unknown type %r for object %r'
597
% (type(suite), suite))
600
class TestSkipped(Exception):
601
"""Indicates that a test was intentionally skipped, rather than failing."""
604
class TestNotApplicable(TestSkipped):
605
"""A test is not applicable to the situation where it was run.
607
This is only normally raised by parameterized tests, if they find that
608
the instance they're constructed upon does not support one aspect
613
class KnownFailure(AssertionError):
614
"""Indicates that a test failed in a precisely expected manner.
616
Such failures dont block the whole test suite from passing because they are
617
indicators of partially completed code or of future work. We have an
618
explicit error for them so that we can ensure that they are always visible:
619
KnownFailures are always shown in the output of bzr selftest.
623
class UnavailableFeature(Exception):
624
"""A feature required for this test was not available.
626
The feature should be used to construct the exception.
630
class CommandFailed(Exception):
634
class StringIOWrapper(object):
635
"""A wrapper around cStringIO which just adds an encoding attribute.
637
Internally we can check sys.stdout to see what the output encoding
638
should be. However, cStringIO has no encoding attribute that we can
639
set. So we wrap it instead.
644
def __init__(self, s=None):
646
self.__dict__['_cstring'] = StringIO(s)
648
self.__dict__['_cstring'] = StringIO()
650
def __getattr__(self, name, getattr=getattr):
651
return getattr(self.__dict__['_cstring'], name)
653
def __setattr__(self, name, val):
654
if name == 'encoding':
655
self.__dict__['encoding'] = val
657
return setattr(self._cstring, name, val)
660
class TestUIFactory(ui.CLIUIFactory):
661
"""A UI Factory for testing.
663
Hide the progress bar but emit note()s.
665
Allows get_password to be tested without real tty attached.
672
super(TestUIFactory, self).__init__()
673
if stdin is not None:
674
# We use a StringIOWrapper to be able to test various
675
# encodings, but the user is still responsible to
676
# encode the string and to set the encoding attribute
677
# of StringIOWrapper.
678
self.stdin = StringIOWrapper(stdin)
680
self.stdout = sys.stdout
684
self.stderr = sys.stderr
689
"""See progress.ProgressBar.clear()."""
691
def clear_term(self):
692
"""See progress.ProgressBar.clear_term()."""
694
def clear_term(self):
695
"""See progress.ProgressBar.clear_term()."""
698
"""See progress.ProgressBar.finished()."""
700
def note(self, fmt_string, *args, **kwargs):
701
"""See progress.ProgressBar.note()."""
702
self.stdout.write((fmt_string + "\n") % args)
704
def progress_bar(self):
707
def nested_progress_bar(self):
710
def update(self, message, count=None, total=None):
711
"""See progress.ProgressBar.update()."""
713
def get_non_echoed_password(self, prompt):
714
"""Get password from stdin without trying to handle the echo mode"""
716
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
717
password = self.stdin.readline()
720
if password[-1] == '\n':
721
password = password[:-1]
725
def _report_leaked_threads():
726
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
727
TestCase._first_thread_leaker_id,
728
TestCase._leaking_threads_tests)
731
class TestCase(unittest.TestCase):
732
"""Base class for bzr unit tests.
734
Tests that need access to disk resources should subclass
735
TestCaseInTempDir not TestCase.
737
Error and debug log messages are redirected from their usual
738
location into a temporary file, the contents of which can be
739
retrieved by _get_log(). We use a real OS file, not an in-memory object,
740
so that it can also capture file IO. When the test completes this file
741
is read into memory and removed from disk.
743
There are also convenience functions to invoke bzr's command-line
744
routine, and to build and check bzr trees.
746
In addition to the usual method of overriding tearDown(), this class also
747
allows subclasses to register functions into the _cleanups list, which is
748
run in order as the object is torn down. It's less likely this will be
749
accidentally overlooked.
752
_active_threads = None
753
_leaking_threads_tests = 0
754
_first_thread_leaker_id = None
755
_log_file_name = None
757
_keep_log_file = False
758
# record lsprof data when performing benchmark calls.
759
_gather_lsprof_in_benchmarks = False
760
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
761
'_log_contents', '_log_file_name', '_benchtime',
762
'_TestCase__testMethodName')
764
def __init__(self, methodName='testMethod'):
765
super(TestCase, self).__init__(methodName)
767
self._bzr_test_setUp_run = False
768
self._bzr_test_tearDown_run = False
771
unittest.TestCase.setUp(self)
772
self._bzr_test_setUp_run = True
773
self._cleanEnvironment()
776
self._benchcalls = []
777
self._benchtime = None
779
self._clear_debug_flags()
780
TestCase._active_threads = threading.activeCount()
781
self.addCleanup(self._check_leaked_threads)
786
pdb.Pdb().set_trace(sys._getframe().f_back)
789
absent_attr = object()
790
exc_info = getattr(self, '_exc_info', absent_attr)
791
if exc_info is absent_attr:
792
exc_info = getattr(self, '_TestCase__exc_info')
795
def _check_leaked_threads(self):
796
active = threading.activeCount()
797
leaked_threads = active - TestCase._active_threads
798
TestCase._active_threads = active
800
TestCase._leaking_threads_tests += 1
801
if TestCase._first_thread_leaker_id is None:
802
TestCase._first_thread_leaker_id = self.id()
803
# we're not specifically told when all tests are finished.
804
# This will do. We use a function to avoid keeping a reference
805
# to a TestCase object.
806
atexit.register(_report_leaked_threads)
808
def _clear_debug_flags(self):
809
"""Prevent externally set debug flags affecting tests.
811
Tests that want to use debug flags can just set them in the
812
debug_flags set during setup/teardown.
814
self._preserved_debug_flags = set(debug.debug_flags)
815
if 'allow_debug' not in selftest_debug_flags:
816
debug.debug_flags.clear()
817
self.addCleanup(self._restore_debug_flags)
819
def _clear_hooks(self):
820
# prevent hooks affecting tests
821
self._preserved_hooks = {}
822
for key, factory in hooks.known_hooks.items():
823
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
824
current_hooks = hooks.known_hooks_key_to_object(key)
825
self._preserved_hooks[parent] = (name, current_hooks)
826
self.addCleanup(self._restoreHooks)
827
for key, factory in hooks.known_hooks.items():
828
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
829
setattr(parent, name, factory())
831
def _silenceUI(self):
832
"""Turn off UI for duration of test"""
833
# by default the UI is off; tests can turn it on if they want it.
834
saved = ui.ui_factory
836
ui.ui_factory = saved
837
ui.ui_factory = ui.SilentUIFactory()
838
self.addCleanup(_restore)
840
def _ndiff_strings(self, a, b):
841
"""Return ndiff between two strings containing lines.
843
A trailing newline is added if missing to make the strings
845
if b and b[-1] != '\n':
847
if a and a[-1] != '\n':
849
difflines = difflib.ndiff(a.splitlines(True),
851
linejunk=lambda x: False,
852
charjunk=lambda x: False)
853
return ''.join(difflines)
855
def assertEqual(self, a, b, message=''):
859
except UnicodeError, e:
860
# If we can't compare without getting a UnicodeError, then
861
# obviously they are different
862
mutter('UnicodeError: %s', e)
865
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
867
pformat(a), pformat(b)))
869
assertEquals = assertEqual
871
def assertEqualDiff(self, a, b, message=None):
872
"""Assert two texts are equal, if not raise an exception.
874
This is intended for use with multi-line strings where it can
875
be hard to find the differences by eye.
877
# TODO: perhaps override assertEquals to call this for strings?
881
message = "texts not equal:\n"
883
message = 'first string is missing a final newline.\n'
885
message = 'second string is missing a final newline.\n'
886
raise AssertionError(message +
887
self._ndiff_strings(a, b))
889
def assertEqualMode(self, mode, mode_test):
890
self.assertEqual(mode, mode_test,
891
'mode mismatch %o != %o' % (mode, mode_test))
893
def assertEqualStat(self, expected, actual):
894
"""assert that expected and actual are the same stat result.
896
:param expected: A stat result.
897
:param actual: A stat result.
898
:raises AssertionError: If the expected and actual stat values differ
901
self.assertEqual(expected.st_size, actual.st_size)
902
self.assertEqual(expected.st_mtime, actual.st_mtime)
903
self.assertEqual(expected.st_ctime, actual.st_ctime)
904
self.assertEqual(expected.st_dev, actual.st_dev)
905
self.assertEqual(expected.st_ino, actual.st_ino)
906
self.assertEqual(expected.st_mode, actual.st_mode)
908
def assertLength(self, length, obj_with_len):
909
"""Assert that obj_with_len is of length length."""
910
if len(obj_with_len) != length:
911
self.fail("Incorrect length: wanted %d, got %d for %r" % (
912
length, len(obj_with_len), obj_with_len))
914
def assertPositive(self, val):
915
"""Assert that val is greater than 0."""
916
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
918
def assertNegative(self, val):
919
"""Assert that val is less than 0."""
920
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
922
def assertStartsWith(self, s, prefix):
923
if not s.startswith(prefix):
924
raise AssertionError('string %r does not start with %r' % (s, prefix))
926
def assertEndsWith(self, s, suffix):
927
"""Asserts that s ends with suffix."""
928
if not s.endswith(suffix):
929
raise AssertionError('string %r does not end with %r' % (s, suffix))
931
def assertContainsRe(self, haystack, needle_re, flags=0):
932
"""Assert that a contains something matching a regular expression."""
933
if not re.search(needle_re, haystack, flags):
934
if '\n' in haystack or len(haystack) > 60:
935
# a long string, format it in a more readable way
936
raise AssertionError(
937
'pattern "%s" not found in\n"""\\\n%s"""\n'
938
% (needle_re, haystack))
940
raise AssertionError('pattern "%s" not found in "%s"'
941
% (needle_re, haystack))
943
def assertNotContainsRe(self, haystack, needle_re, flags=0):
944
"""Assert that a does not match a regular expression"""
945
if re.search(needle_re, haystack, flags):
946
raise AssertionError('pattern "%s" found in "%s"'
947
% (needle_re, haystack))
949
def assertSubset(self, sublist, superlist):
950
"""Assert that every entry in sublist is present in superlist."""
951
missing = set(sublist) - set(superlist)
953
raise AssertionError("value(s) %r not present in container %r" %
954
(missing, superlist))
956
def assertListRaises(self, excClass, func, *args, **kwargs):
957
"""Fail unless excClass is raised when the iterator from func is used.
959
Many functions can return generators this makes sure
960
to wrap them in a list() call to make sure the whole generator
961
is run, and that the proper exception is raised.
964
list(func(*args, **kwargs))
968
if getattr(excClass,'__name__', None) is not None:
969
excName = excClass.__name__
971
excName = str(excClass)
972
raise self.failureException, "%s not raised" % excName
974
def assertRaises(self, excClass, callableObj, *args, **kwargs):
975
"""Assert that a callable raises a particular exception.
977
:param excClass: As for the except statement, this may be either an
978
exception class, or a tuple of classes.
979
:param callableObj: A callable, will be passed ``*args`` and
982
Returns the exception so that you can examine it.
985
callableObj(*args, **kwargs)
989
if getattr(excClass,'__name__', None) is not None:
990
excName = excClass.__name__
993
excName = str(excClass)
994
raise self.failureException, "%s not raised" % excName
996
def assertIs(self, left, right, message=None):
997
if not (left is right):
998
if message is not None:
999
raise AssertionError(message)
1001
raise AssertionError("%r is not %r." % (left, right))
1003
def assertIsNot(self, left, right, message=None):
1005
if message is not None:
1006
raise AssertionError(message)
1008
raise AssertionError("%r is %r." % (left, right))
1010
def assertTransportMode(self, transport, path, mode):
1011
"""Fail if a path does not have mode mode.
1013
If modes are not supported on this transport, the assertion is ignored.
1015
if not transport._can_roundtrip_unix_modebits():
1017
path_stat = transport.stat(path)
1018
actual_mode = stat.S_IMODE(path_stat.st_mode)
1019
self.assertEqual(mode, actual_mode,
1020
'mode of %r incorrect (%s != %s)'
1021
% (path, oct(mode), oct(actual_mode)))
1023
def assertIsSameRealPath(self, path1, path2):
1024
"""Fail if path1 and path2 points to different files"""
1025
self.assertEqual(osutils.realpath(path1),
1026
osutils.realpath(path2),
1027
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1029
def assertIsInstance(self, obj, kls):
1030
"""Fail if obj is not an instance of kls"""
1031
if not isinstance(obj, kls):
1032
self.fail("%r is an instance of %s rather than %s" % (
1033
obj, obj.__class__, kls))
1035
def expectFailure(self, reason, assertion, *args, **kwargs):
1036
"""Invoke a test, expecting it to fail for the given reason.
1038
This is for assertions that ought to succeed, but currently fail.
1039
(The failure is *expected* but not *wanted*.) Please be very precise
1040
about the failure you're expecting. If a new bug is introduced,
1041
AssertionError should be raised, not KnownFailure.
1043
Frequently, expectFailure should be followed by an opposite assertion.
1046
Intended to be used with a callable that raises AssertionError as the
1047
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1049
Raises KnownFailure if the test fails. Raises AssertionError if the
1054
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1056
self.assertEqual(42, dynamic_val)
1058
This means that a dynamic_val of 54 will cause the test to raise
1059
a KnownFailure. Once math is fixed and the expectFailure is removed,
1060
only a dynamic_val of 42 will allow the test to pass. Anything other
1061
than 54 or 42 will cause an AssertionError.
1064
assertion(*args, **kwargs)
1065
except AssertionError:
1066
raise KnownFailure(reason)
1068
self.fail('Unexpected success. Should have failed: %s' % reason)
1070
def assertFileEqual(self, content, path):
1071
"""Fail if path does not contain 'content'."""
1072
self.failUnlessExists(path)
1073
f = file(path, 'rb')
1078
self.assertEqualDiff(content, s)
1080
def failUnlessExists(self, path):
1081
"""Fail unless path or paths, which may be abs or relative, exist."""
1082
if not isinstance(path, basestring):
1084
self.failUnlessExists(p)
1086
self.failUnless(osutils.lexists(path),path+" does not exist")
1088
def failIfExists(self, path):
1089
"""Fail if path or paths, which may be abs or relative, exist."""
1090
if not isinstance(path, basestring):
1092
self.failIfExists(p)
1094
self.failIf(osutils.lexists(path),path+" exists")
1096
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1097
"""A helper for callDeprecated and applyDeprecated.
1099
:param a_callable: A callable to call.
1100
:param args: The positional arguments for the callable
1101
:param kwargs: The keyword arguments for the callable
1102
:return: A tuple (warnings, result). result is the result of calling
1103
a_callable(``*args``, ``**kwargs``).
1106
def capture_warnings(msg, cls=None, stacklevel=None):
1107
# we've hooked into a deprecation specific callpath,
1108
# only deprecations should getting sent via it.
1109
self.assertEqual(cls, DeprecationWarning)
1110
local_warnings.append(msg)
1111
original_warning_method = symbol_versioning.warn
1112
symbol_versioning.set_warning_method(capture_warnings)
1114
result = a_callable(*args, **kwargs)
1116
symbol_versioning.set_warning_method(original_warning_method)
1117
return (local_warnings, result)
1119
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1120
"""Call a deprecated callable without warning the user.
1122
Note that this only captures warnings raised by symbol_versioning.warn,
1123
not other callers that go direct to the warning module.
1125
To test that a deprecated method raises an error, do something like
1128
self.assertRaises(errors.ReservedId,
1129
self.applyDeprecated,
1130
deprecated_in((1, 5, 0)),
1134
:param deprecation_format: The deprecation format that the callable
1135
should have been deprecated with. This is the same type as the
1136
parameter to deprecated_method/deprecated_function. If the
1137
callable is not deprecated with this format, an assertion error
1139
:param a_callable: A callable to call. This may be a bound method or
1140
a regular function. It will be called with ``*args`` and
1142
:param args: The positional arguments for the callable
1143
:param kwargs: The keyword arguments for the callable
1144
:return: The result of a_callable(``*args``, ``**kwargs``)
1146
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1148
expected_first_warning = symbol_versioning.deprecation_string(
1149
a_callable, deprecation_format)
1150
if len(call_warnings) == 0:
1151
self.fail("No deprecation warning generated by call to %s" %
1153
self.assertEqual(expected_first_warning, call_warnings[0])
1156
def callCatchWarnings(self, fn, *args, **kw):
1157
"""Call a callable that raises python warnings.
1159
The caller's responsible for examining the returned warnings.
1161
If the callable raises an exception, the exception is not
1162
caught and propagates up to the caller. In that case, the list
1163
of warnings is not available.
1165
:returns: ([warning_object, ...], fn_result)
1167
# XXX: This is not perfect, because it completely overrides the
1168
# warnings filters, and some code may depend on suppressing particular
1169
# warnings. It's the easiest way to insulate ourselves from -Werror,
1170
# though. -- Andrew, 20071062
1172
def _catcher(message, category, filename, lineno, file=None, line=None):
1173
# despite the name, 'message' is normally(?) a Warning subclass
1175
wlist.append(message)
1176
saved_showwarning = warnings.showwarning
1177
saved_filters = warnings.filters
1179
warnings.showwarning = _catcher
1180
warnings.filters = []
1181
result = fn(*args, **kw)
1183
warnings.showwarning = saved_showwarning
1184
warnings.filters = saved_filters
1185
return wlist, result
1187
def callDeprecated(self, expected, callable, *args, **kwargs):
1188
"""Assert that a callable is deprecated in a particular way.
1190
This is a very precise test for unusual requirements. The
1191
applyDeprecated helper function is probably more suited for most tests
1192
as it allows you to simply specify the deprecation format being used
1193
and will ensure that that is issued for the function being called.
1195
Note that this only captures warnings raised by symbol_versioning.warn,
1196
not other callers that go direct to the warning module. To catch
1197
general warnings, use callCatchWarnings.
1199
:param expected: a list of the deprecation warnings expected, in order
1200
:param callable: The callable to call
1201
:param args: The positional arguments for the callable
1202
:param kwargs: The keyword arguments for the callable
1204
call_warnings, result = self._capture_deprecation_warnings(callable,
1206
self.assertEqual(expected, call_warnings)
1209
def _startLogFile(self):
1210
"""Send bzr and test log messages to a temporary file.
1212
The file is removed as the test is torn down.
1214
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1215
self._log_file = os.fdopen(fileno, 'w+')
1216
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1217
self._log_file_name = name
1218
self.addCleanup(self._finishLogFile)
1220
def _finishLogFile(self):
1221
"""Finished with the log file.
1223
Close the file and delete it, unless setKeepLogfile was called.
1225
if self._log_file is None:
1227
bzrlib.trace.pop_log_file(self._log_memento)
1228
self._log_file.close()
1229
self._log_file = None
1230
if not self._keep_log_file:
1231
os.remove(self._log_file_name)
1232
self._log_file_name = None
1234
def setKeepLogfile(self):
1235
"""Make the logfile not be deleted when _finishLogFile is called."""
1236
self._keep_log_file = True
1238
def addCleanup(self, callable, *args, **kwargs):
1239
"""Arrange to run a callable when this case is torn down.
1241
Callables are run in the reverse of the order they are registered,
1242
ie last-in first-out.
1244
self._cleanups.append((callable, args, kwargs))
1246
def _cleanEnvironment(self):
1248
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1249
'HOME': os.getcwd(),
1250
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1251
# tests do check our impls match APPDATA
1252
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1254
'BZREMAIL': None, # may still be present in the environment
1256
'BZR_PROGRESS_BAR': None,
1258
'BZR_PLUGIN_PATH': None,
1260
'SSH_AUTH_SOCK': None,
1264
'https_proxy': None,
1265
'HTTPS_PROXY': None,
1270
# Nobody cares about these ones AFAIK. So far at
1271
# least. If you do (care), please update this comment
1275
'BZR_REMOTE_PATH': None,
1278
self.addCleanup(self._restoreEnvironment)
1279
for name, value in new_env.iteritems():
1280
self._captureVar(name, value)
1282
def _captureVar(self, name, newvalue):
1283
"""Set an environment variable, and reset it when finished."""
1284
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1286
def _restore_debug_flags(self):
1287
debug.debug_flags.clear()
1288
debug.debug_flags.update(self._preserved_debug_flags)
1290
def _restoreEnvironment(self):
1291
for name, value in self.__old_env.iteritems():
1292
osutils.set_or_unset_env(name, value)
1294
def _restoreHooks(self):
1295
for klass, (name, hooks) in self._preserved_hooks.items():
1296
setattr(klass, name, hooks)
1298
def knownFailure(self, reason):
1299
"""This test has failed for some known reason."""
1300
raise KnownFailure(reason)
1302
def _do_skip(self, result, reason):
1303
addSkip = getattr(result, 'addSkip', None)
1304
if not callable(addSkip):
1305
result.addError(self, self.exc_info())
1307
addSkip(self, reason)
1309
def run(self, result=None):
1310
if result is None: result = self.defaultTestResult()
1311
for feature in getattr(self, '_test_needs_features', []):
1312
if not feature.available():
1313
result.startTest(self)
1314
if getattr(result, 'addNotSupported', None):
1315
result.addNotSupported(self, feature)
1317
result.addSuccess(self)
1318
result.stopTest(self)
1322
result.startTest(self)
1323
absent_attr = object()
1325
method_name = getattr(self, '_testMethodName', absent_attr)
1326
if method_name is absent_attr:
1328
method_name = getattr(self, '_TestCase__testMethodName')
1329
testMethod = getattr(self, method_name)
1333
if not self._bzr_test_setUp_run:
1335
"test setUp did not invoke "
1336
"bzrlib.tests.TestCase's setUp")
1337
except KeyboardInterrupt:
1339
except TestSkipped, e:
1340
self._do_skip(result, e.args[0])
1344
result.addError(self, self.exc_info())
1351
except self.failureException:
1352
result.addFailure(self, self.exc_info())
1353
except TestSkipped, e:
1355
reason = "No reason given."
1358
self._do_skip(result, reason)
1359
except KeyboardInterrupt:
1362
result.addError(self, self.exc_info())
1366
if not self._bzr_test_tearDown_run:
1368
"test tearDown did not invoke "
1369
"bzrlib.tests.TestCase's tearDown")
1370
except KeyboardInterrupt:
1373
result.addError(self, self.exc_info())
1375
if ok: result.addSuccess(self)
1377
result.stopTest(self)
1379
except TestNotApplicable:
1380
# Not moved from the result [yet].
1382
except KeyboardInterrupt:
1386
absent_attr = object()
1387
for attr_name in self.attrs_to_keep:
1388
attr = getattr(self, attr_name, absent_attr)
1389
if attr is not absent_attr:
1390
saved_attrs[attr_name] = attr
1391
self.__dict__ = saved_attrs
1394
self._bzr_test_tearDown_run = True
1396
self._log_contents = ''
1397
unittest.TestCase.tearDown(self)
1399
def time(self, callable, *args, **kwargs):
1400
"""Run callable and accrue the time it takes to the benchmark time.
1402
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1403
this will cause lsprofile statistics to be gathered and stored in
1406
if self._benchtime is None:
1410
if not self._gather_lsprof_in_benchmarks:
1411
return callable(*args, **kwargs)
1413
# record this benchmark
1414
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1416
self._benchcalls.append(((callable, args, kwargs), stats))
1419
self._benchtime += time.time() - start
1421
def _runCleanups(self):
1422
"""Run registered cleanup functions.
1424
This should only be called from TestCase.tearDown.
1426
# TODO: Perhaps this should keep running cleanups even if
1427
# one of them fails?
1429
# Actually pop the cleanups from the list so tearDown running
1430
# twice is safe (this happens for skipped tests).
1431
while self._cleanups:
1432
cleanup, args, kwargs = self._cleanups.pop()
1433
cleanup(*args, **kwargs)
1435
def log(self, *args):
1438
def _get_log(self, keep_log_file=False):
1439
"""Get the log from bzrlib.trace calls from this test.
1441
:param keep_log_file: When True, if the log is still a file on disk
1442
leave it as a file on disk. When False, if the log is still a file
1443
on disk, the log file is deleted and the log preserved as
1445
:return: A string containing the log.
1447
# flush the log file, to get all content
1449
if bzrlib.trace._trace_file:
1450
bzrlib.trace._trace_file.flush()
1451
if self._log_contents:
1452
# XXX: this can hardly contain the content flushed above --vila
1454
return self._log_contents
1455
if self._log_file_name is not None:
1456
logfile = open(self._log_file_name)
1458
log_contents = logfile.read()
1461
if not keep_log_file:
1462
self._log_contents = log_contents
1464
os.remove(self._log_file_name)
1466
if sys.platform == 'win32' and e.errno == errno.EACCES:
1467
sys.stderr.write(('Unable to delete log file '
1468
' %r\n' % self._log_file_name))
1473
return "DELETED log file to reduce memory footprint"
1475
def requireFeature(self, feature):
1476
"""This test requires a specific feature is available.
1478
:raises UnavailableFeature: When feature is not available.
1480
if not feature.available():
1481
raise UnavailableFeature(feature)
1483
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1485
"""Run bazaar command line, splitting up a string command line."""
1486
if isinstance(args, basestring):
1487
# shlex don't understand unicode strings,
1488
# so args should be plain string (bialix 20070906)
1489
args = list(shlex.split(str(args)))
1490
return self._run_bzr_core(args, retcode=retcode,
1491
encoding=encoding, stdin=stdin, working_dir=working_dir,
1494
def _run_bzr_core(self, args, retcode, encoding, stdin,
1496
if encoding is None:
1497
encoding = osutils.get_user_encoding()
1498
stdout = StringIOWrapper()
1499
stderr = StringIOWrapper()
1500
stdout.encoding = encoding
1501
stderr.encoding = encoding
1503
self.log('run bzr: %r', args)
1504
# FIXME: don't call into logging here
1505
handler = logging.StreamHandler(stderr)
1506
handler.setLevel(logging.INFO)
1507
logger = logging.getLogger('')
1508
logger.addHandler(handler)
1509
old_ui_factory = ui.ui_factory
1510
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1513
if working_dir is not None:
1514
cwd = osutils.getcwd()
1515
os.chdir(working_dir)
1518
result = self.apply_redirected(ui.ui_factory.stdin,
1520
bzrlib.commands.run_bzr_catch_user_errors,
1523
logger.removeHandler(handler)
1524
ui.ui_factory = old_ui_factory
1528
out = stdout.getvalue()
1529
err = stderr.getvalue()
1531
self.log('output:\n%r', out)
1533
self.log('errors:\n%r', err)
1534
if retcode is not None:
1535
self.assertEquals(retcode, result,
1536
message='Unexpected return code')
1539
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1540
working_dir=None, error_regexes=[], output_encoding=None):
1541
"""Invoke bzr, as if it were run from the command line.
1543
The argument list should not include the bzr program name - the
1544
first argument is normally the bzr command. Arguments may be
1545
passed in three ways:
1547
1- A list of strings, eg ["commit", "a"]. This is recommended
1548
when the command contains whitespace or metacharacters, or
1549
is built up at run time.
1551
2- A single string, eg "add a". This is the most convenient
1552
for hardcoded commands.
1554
This runs bzr through the interface that catches and reports
1555
errors, and with logging set to something approximating the
1556
default, so that error reporting can be checked.
1558
This should be the main method for tests that want to exercise the
1559
overall behavior of the bzr application (rather than a unit test
1560
or a functional test of the library.)
1562
This sends the stdout/stderr results into the test's log,
1563
where it may be useful for debugging. See also run_captured.
1565
:keyword stdin: A string to be used as stdin for the command.
1566
:keyword retcode: The status code the command should return;
1568
:keyword working_dir: The directory to run the command in
1569
:keyword error_regexes: A list of expected error messages. If
1570
specified they must be seen in the error output of the command.
1572
out, err = self._run_bzr_autosplit(
1577
working_dir=working_dir,
1579
for regex in error_regexes:
1580
self.assertContainsRe(err, regex)
1583
def run_bzr_error(self, error_regexes, *args, **kwargs):
1584
"""Run bzr, and check that stderr contains the supplied regexes
1586
:param error_regexes: Sequence of regular expressions which
1587
must each be found in the error output. The relative ordering
1589
:param args: command-line arguments for bzr
1590
:param kwargs: Keyword arguments which are interpreted by run_bzr
1591
This function changes the default value of retcode to be 3,
1592
since in most cases this is run when you expect bzr to fail.
1594
:return: (out, err) The actual output of running the command (in case
1595
you want to do more inspection)
1599
# Make sure that commit is failing because there is nothing to do
1600
self.run_bzr_error(['no changes to commit'],
1601
['commit', '-m', 'my commit comment'])
1602
# Make sure --strict is handling an unknown file, rather than
1603
# giving us the 'nothing to do' error
1604
self.build_tree(['unknown'])
1605
self.run_bzr_error(['Commit refused because there are unknown files'],
1606
['commit', --strict', '-m', 'my commit comment'])
1608
kwargs.setdefault('retcode', 3)
1609
kwargs['error_regexes'] = error_regexes
1610
out, err = self.run_bzr(*args, **kwargs)
1613
def run_bzr_subprocess(self, *args, **kwargs):
1614
"""Run bzr in a subprocess for testing.
1616
This starts a new Python interpreter and runs bzr in there.
1617
This should only be used for tests that have a justifiable need for
1618
this isolation: e.g. they are testing startup time, or signal
1619
handling, or early startup code, etc. Subprocess code can't be
1620
profiled or debugged so easily.
1622
:keyword retcode: The status code that is expected. Defaults to 0. If
1623
None is supplied, the status code is not checked.
1624
:keyword env_changes: A dictionary which lists changes to environment
1625
variables. A value of None will unset the env variable.
1626
The values must be strings. The change will only occur in the
1627
child, so you don't need to fix the environment after running.
1628
:keyword universal_newlines: Convert CRLF => LF
1629
:keyword allow_plugins: By default the subprocess is run with
1630
--no-plugins to ensure test reproducibility. Also, it is possible
1631
for system-wide plugins to create unexpected output on stderr,
1632
which can cause unnecessary test failures.
1634
env_changes = kwargs.get('env_changes', {})
1635
working_dir = kwargs.get('working_dir', None)
1636
allow_plugins = kwargs.get('allow_plugins', False)
1638
if isinstance(args[0], list):
1640
elif isinstance(args[0], basestring):
1641
args = list(shlex.split(args[0]))
1643
raise ValueError("passing varargs to run_bzr_subprocess")
1644
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1645
working_dir=working_dir,
1646
allow_plugins=allow_plugins)
1647
# We distinguish between retcode=None and retcode not passed.
1648
supplied_retcode = kwargs.get('retcode', 0)
1649
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1650
universal_newlines=kwargs.get('universal_newlines', False),
1653
def start_bzr_subprocess(self, process_args, env_changes=None,
1654
skip_if_plan_to_signal=False,
1656
allow_plugins=False):
1657
"""Start bzr in a subprocess for testing.
1659
This starts a new Python interpreter and runs bzr in there.
1660
This should only be used for tests that have a justifiable need for
1661
this isolation: e.g. they are testing startup time, or signal
1662
handling, or early startup code, etc. Subprocess code can't be
1663
profiled or debugged so easily.
1665
:param process_args: a list of arguments to pass to the bzr executable,
1666
for example ``['--version']``.
1667
:param env_changes: A dictionary which lists changes to environment
1668
variables. A value of None will unset the env variable.
1669
The values must be strings. The change will only occur in the
1670
child, so you don't need to fix the environment after running.
1671
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1673
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1675
:returns: Popen object for the started process.
1677
if skip_if_plan_to_signal:
1678
if not getattr(os, 'kill', None):
1679
raise TestSkipped("os.kill not available.")
1681
if env_changes is None:
1685
def cleanup_environment():
1686
for env_var, value in env_changes.iteritems():
1687
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1689
def restore_environment():
1690
for env_var, value in old_env.iteritems():
1691
osutils.set_or_unset_env(env_var, value)
1693
bzr_path = self.get_bzr_path()
1696
if working_dir is not None:
1697
cwd = osutils.getcwd()
1698
os.chdir(working_dir)
1701
# win32 subprocess doesn't support preexec_fn
1702
# so we will avoid using it on all platforms, just to
1703
# make sure the code path is used, and we don't break on win32
1704
cleanup_environment()
1705
command = [sys.executable]
1706
# frozen executables don't need the path to bzr
1707
if getattr(sys, "frozen", None) is None:
1708
command.append(bzr_path)
1709
if not allow_plugins:
1710
command.append('--no-plugins')
1711
command.extend(process_args)
1712
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1714
restore_environment()
1720
def _popen(self, *args, **kwargs):
1721
"""Place a call to Popen.
1723
Allows tests to override this method to intercept the calls made to
1724
Popen for introspection.
1726
return Popen(*args, **kwargs)
1728
def get_bzr_path(self):
1729
"""Return the path of the 'bzr' executable for this test suite."""
1730
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1731
if not os.path.isfile(bzr_path):
1732
# We are probably installed. Assume sys.argv is the right file
1733
bzr_path = sys.argv[0]
1736
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1737
universal_newlines=False, process_args=None):
1738
"""Finish the execution of process.
1740
:param process: the Popen object returned from start_bzr_subprocess.
1741
:param retcode: The status code that is expected. Defaults to 0. If
1742
None is supplied, the status code is not checked.
1743
:param send_signal: an optional signal to send to the process.
1744
:param universal_newlines: Convert CRLF => LF
1745
:returns: (stdout, stderr)
1747
if send_signal is not None:
1748
os.kill(process.pid, send_signal)
1749
out, err = process.communicate()
1751
if universal_newlines:
1752
out = out.replace('\r\n', '\n')
1753
err = err.replace('\r\n', '\n')
1755
if retcode is not None and retcode != process.returncode:
1756
if process_args is None:
1757
process_args = "(unknown args)"
1758
mutter('Output of bzr %s:\n%s', process_args, out)
1759
mutter('Error for bzr %s:\n%s', process_args, err)
1760
self.fail('Command bzr %s failed with retcode %s != %s'
1761
% (process_args, retcode, process.returncode))
1764
def check_inventory_shape(self, inv, shape):
1765
"""Compare an inventory to a list of expected names.
1767
Fail if they are not precisely equal.
1770
shape = list(shape) # copy
1771
for path, ie in inv.entries():
1772
name = path.replace('\\', '/')
1773
if ie.kind == 'directory':
1780
self.fail("expected paths not found in inventory: %r" % shape)
1782
self.fail("unexpected paths found in inventory: %r" % extras)
1784
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1785
a_callable=None, *args, **kwargs):
1786
"""Call callable with redirected std io pipes.
1788
Returns the return code."""
1789
if not callable(a_callable):
1790
raise ValueError("a_callable must be callable.")
1792
stdin = StringIO("")
1794
if getattr(self, "_log_file", None) is not None:
1795
stdout = self._log_file
1799
if getattr(self, "_log_file", None is not None):
1800
stderr = self._log_file
1803
real_stdin = sys.stdin
1804
real_stdout = sys.stdout
1805
real_stderr = sys.stderr
1810
return a_callable(*args, **kwargs)
1812
sys.stdout = real_stdout
1813
sys.stderr = real_stderr
1814
sys.stdin = real_stdin
1816
def reduceLockdirTimeout(self):
1817
"""Reduce the default lock timeout for the duration of the test, so that
1818
if LockContention occurs during a test, it does so quickly.
1820
Tests that expect to provoke LockContention errors should call this.
1822
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1824
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1825
self.addCleanup(resetTimeout)
1826
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1828
def make_utf8_encoded_stringio(self, encoding_type=None):
1829
"""Return a StringIOWrapper instance, that will encode Unicode
1832
if encoding_type is None:
1833
encoding_type = 'strict'
1835
output_encoding = 'utf-8'
1836
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1837
sio.encoding = output_encoding
1841
class CapturedCall(object):
1842
"""A helper for capturing smart server calls for easy debug analysis."""
1844
def __init__(self, params, prefix_length):
1845
"""Capture the call with params and skip prefix_length stack frames."""
1848
# The last 5 frames are the __init__, the hook frame, and 3 smart
1849
# client frames. Beyond this we could get more clever, but this is good
1851
stack = traceback.extract_stack()[prefix_length:-5]
1852
self.stack = ''.join(traceback.format_list(stack))
1855
return self.call.method
1858
return self.call.method
1864
class TestCaseWithMemoryTransport(TestCase):
1865
"""Common test class for tests that do not need disk resources.
1867
Tests that need disk resources should derive from TestCaseWithTransport.
1869
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1871
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1872
a directory which does not exist. This serves to help ensure test isolation
1873
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1874
must exist. However, TestCaseWithMemoryTransport does not offer local
1875
file defaults for the transport in tests, nor does it obey the command line
1876
override, so tests that accidentally write to the common directory should
1879
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1880
a .bzr directory that stops us ascending higher into the filesystem.
1886
def __init__(self, methodName='runTest'):
1887
# allow test parameterization after test construction and before test
1888
# execution. Variables that the parameterizer sets need to be
1889
# ones that are not set by setUp, or setUp will trash them.
1890
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1891
self.vfs_transport_factory = default_transport
1892
self.transport_server = None
1893
self.transport_readonly_server = None
1894
self.__vfs_server = None
1896
def get_transport(self, relpath=None):
1897
"""Return a writeable transport.
1899
This transport is for the test scratch space relative to
1902
:param relpath: a path relative to the base url.
1904
t = get_transport(self.get_url(relpath))
1905
self.assertFalse(t.is_readonly())
1908
def get_readonly_transport(self, relpath=None):
1909
"""Return a readonly transport for the test scratch space
1911
This can be used to test that operations which should only need
1912
readonly access in fact do not try to write.
1914
:param relpath: a path relative to the base url.
1916
t = get_transport(self.get_readonly_url(relpath))
1917
self.assertTrue(t.is_readonly())
1920
def create_transport_readonly_server(self):
1921
"""Create a transport server from class defined at init.
1923
This is mostly a hook for daughter classes.
1925
return self.transport_readonly_server()
1927
def get_readonly_server(self):
1928
"""Get the server instance for the readonly transport
1930
This is useful for some tests with specific servers to do diagnostics.
1932
if self.__readonly_server is None:
1933
if self.transport_readonly_server is None:
1934
# readonly decorator requested
1935
# bring up the server
1936
self.__readonly_server = ReadonlyServer()
1937
self.__readonly_server.setUp(self.get_vfs_only_server())
1939
self.__readonly_server = self.create_transport_readonly_server()
1940
self.__readonly_server.setUp(self.get_vfs_only_server())
1941
self.addCleanup(self.__readonly_server.tearDown)
1942
return self.__readonly_server
1944
def get_readonly_url(self, relpath=None):
1945
"""Get a URL for the readonly transport.
1947
This will either be backed by '.' or a decorator to the transport
1948
used by self.get_url()
1949
relpath provides for clients to get a path relative to the base url.
1950
These should only be downwards relative, not upwards.
1952
base = self.get_readonly_server().get_url()
1953
return self._adjust_url(base, relpath)
1955
def get_vfs_only_server(self):
1956
"""Get the vfs only read/write server instance.
1958
This is useful for some tests with specific servers that need
1961
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1962
is no means to override it.
1964
if self.__vfs_server is None:
1965
self.__vfs_server = MemoryServer()
1966
self.__vfs_server.setUp()
1967
self.addCleanup(self.__vfs_server.tearDown)
1968
return self.__vfs_server
1970
def get_server(self):
1971
"""Get the read/write server instance.
1973
This is useful for some tests with specific servers that need
1976
This is built from the self.transport_server factory. If that is None,
1977
then the self.get_vfs_server is returned.
1979
if self.__server is None:
1980
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1981
return self.get_vfs_only_server()
1983
# bring up a decorated means of access to the vfs only server.
1984
self.__server = self.transport_server()
1986
self.__server.setUp(self.get_vfs_only_server())
1987
except TypeError, e:
1988
# This should never happen; the try:Except here is to assist
1989
# developers having to update code rather than seeing an
1990
# uninformative TypeError.
1991
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1992
self.addCleanup(self.__server.tearDown)
1993
return self.__server
1995
def _adjust_url(self, base, relpath):
1996
"""Get a URL (or maybe a path) for the readwrite transport.
1998
This will either be backed by '.' or to an equivalent non-file based
2000
relpath provides for clients to get a path relative to the base url.
2001
These should only be downwards relative, not upwards.
2003
if relpath is not None and relpath != '.':
2004
if not base.endswith('/'):
2006
# XXX: Really base should be a url; we did after all call
2007
# get_url()! But sometimes it's just a path (from
2008
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2009
# to a non-escaped local path.
2010
if base.startswith('./') or base.startswith('/'):
2013
base += urlutils.escape(relpath)
2016
def get_url(self, relpath=None):
2017
"""Get a URL (or maybe a path) for the readwrite transport.
2019
This will either be backed by '.' or to an equivalent non-file based
2021
relpath provides for clients to get a path relative to the base url.
2022
These should only be downwards relative, not upwards.
2024
base = self.get_server().get_url()
2025
return self._adjust_url(base, relpath)
2027
def get_vfs_only_url(self, relpath=None):
2028
"""Get a URL (or maybe a path for the plain old vfs transport.
2030
This will never be a smart protocol. It always has all the
2031
capabilities of the local filesystem, but it might actually be a
2032
MemoryTransport or some other similar virtual filesystem.
2034
This is the backing transport (if any) of the server returned by
2035
get_url and get_readonly_url.
2037
:param relpath: provides for clients to get a path relative to the base
2038
url. These should only be downwards relative, not upwards.
2041
base = self.get_vfs_only_server().get_url()
2042
return self._adjust_url(base, relpath)
2044
def _create_safety_net(self):
2045
"""Make a fake bzr directory.
2047
This prevents any tests propagating up onto the TEST_ROOT directory's
2050
root = TestCaseWithMemoryTransport.TEST_ROOT
2051
bzrdir.BzrDir.create_standalone_workingtree(root)
2053
def _check_safety_net(self):
2054
"""Check that the safety .bzr directory have not been touched.
2056
_make_test_root have created a .bzr directory to prevent tests from
2057
propagating. This method ensures than a test did not leaked.
2059
root = TestCaseWithMemoryTransport.TEST_ROOT
2060
wt = workingtree.WorkingTree.open(root)
2061
last_rev = wt.last_revision()
2062
if last_rev != 'null:':
2063
# The current test have modified the /bzr directory, we need to
2064
# recreate a new one or all the followng tests will fail.
2065
# If you need to inspect its content uncomment the following line
2066
# import pdb; pdb.set_trace()
2067
_rmtree_temp_dir(root + '/.bzr')
2068
self._create_safety_net()
2069
raise AssertionError('%s/.bzr should not be modified' % root)
2071
def _make_test_root(self):
2072
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2073
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2074
TestCaseWithMemoryTransport.TEST_ROOT = root
2076
self._create_safety_net()
2078
# The same directory is used by all tests, and we're not
2079
# specifically told when all tests are finished. This will do.
2080
atexit.register(_rmtree_temp_dir, root)
2082
self.addCleanup(self._check_safety_net)
2084
def makeAndChdirToTestDir(self):
2085
"""Create a temporary directories for this one test.
2087
This must set self.test_home_dir and self.test_dir and chdir to
2090
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2092
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2093
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2094
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2096
def make_branch(self, relpath, format=None):
2097
"""Create a branch on the transport at relpath."""
2098
repo = self.make_repository(relpath, format=format)
2099
return repo.bzrdir.create_branch()
2101
def make_bzrdir(self, relpath, format=None):
2103
# might be a relative or absolute path
2104
maybe_a_url = self.get_url(relpath)
2105
segments = maybe_a_url.rsplit('/', 1)
2106
t = get_transport(maybe_a_url)
2107
if len(segments) > 1 and segments[-1] not in ('', '.'):
2111
if isinstance(format, basestring):
2112
format = bzrdir.format_registry.make_bzrdir(format)
2113
return format.initialize_on_transport(t)
2114
except errors.UninitializableFormat:
2115
raise TestSkipped("Format %s is not initializable." % format)
2117
def make_repository(self, relpath, shared=False, format=None):
2118
"""Create a repository on our default transport at relpath.
2120
Note that relpath must be a relative path, not a full url.
2122
# FIXME: If you create a remoterepository this returns the underlying
2123
# real format, which is incorrect. Actually we should make sure that
2124
# RemoteBzrDir returns a RemoteRepository.
2125
# maybe mbp 20070410
2126
made_control = self.make_bzrdir(relpath, format=format)
2127
return made_control.create_repository(shared=shared)
2129
def make_smart_server(self, path):
2130
smart_server = server.SmartTCPServer_for_testing()
2131
smart_server.setUp(self.get_server())
2132
remote_transport = get_transport(smart_server.get_url()).clone(path)
2133
self.addCleanup(smart_server.tearDown)
2134
return remote_transport
2136
def make_branch_and_memory_tree(self, relpath, format=None):
2137
"""Create a branch on the default transport and a MemoryTree for it."""
2138
b = self.make_branch(relpath, format=format)
2139
return memorytree.MemoryTree.create_on_branch(b)
2141
def make_branch_builder(self, relpath, format=None):
2142
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2145
def overrideEnvironmentForTesting(self):
2146
os.environ['HOME'] = self.test_home_dir
2147
os.environ['BZR_HOME'] = self.test_home_dir
2150
super(TestCaseWithMemoryTransport, self).setUp()
2151
self._make_test_root()
2152
_currentdir = os.getcwdu()
2153
def _leaveDirectory():
2154
os.chdir(_currentdir)
2155
self.addCleanup(_leaveDirectory)
2156
self.makeAndChdirToTestDir()
2157
self.overrideEnvironmentForTesting()
2158
self.__readonly_server = None
2159
self.__server = None
2160
self.reduceLockdirTimeout()
2162
def setup_smart_server_with_call_log(self):
2163
"""Sets up a smart server as the transport server with a call log."""
2164
self.transport_server = server.SmartTCPServer_for_testing
2165
self.hpss_calls = []
2167
# Skip the current stack down to the caller of
2168
# setup_smart_server_with_call_log
2169
prefix_length = len(traceback.extract_stack()) - 2
2170
def capture_hpss_call(params):
2171
self.hpss_calls.append(
2172
CapturedCall(params, prefix_length))
2173
client._SmartClient.hooks.install_named_hook(
2174
'call', capture_hpss_call, None)
2176
def reset_smart_call_log(self):
2177
self.hpss_calls = []
2180
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2181
"""Derived class that runs a test within a temporary directory.
2183
This is useful for tests that need to create a branch, etc.
2185
The directory is created in a slightly complex way: for each
2186
Python invocation, a new temporary top-level directory is created.
2187
All test cases create their own directory within that. If the
2188
tests complete successfully, the directory is removed.
2190
:ivar test_base_dir: The path of the top-level directory for this
2191
test, which contains a home directory and a work directory.
2193
:ivar test_home_dir: An initially empty directory under test_base_dir
2194
which is used as $HOME for this test.
2196
:ivar test_dir: A directory under test_base_dir used as the current
2197
directory when the test proper is run.
2200
OVERRIDE_PYTHON = 'python'
2202
def check_file_contents(self, filename, expect):
2203
self.log("check contents of file %s" % filename)
2204
contents = file(filename, 'r').read()
2205
if contents != expect:
2206
self.log("expected: %r" % expect)
2207
self.log("actually: %r" % contents)
2208
self.fail("contents of %s not as expected" % filename)
2210
def _getTestDirPrefix(self):
2211
# create a directory within the top level test directory
2212
if sys.platform == 'win32':
2213
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2214
# windows is likely to have path-length limits so use a short name
2215
name_prefix = name_prefix[-30:]
2217
name_prefix = re.sub('[/]', '_', self.id())
2220
def makeAndChdirToTestDir(self):
2221
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2223
For TestCaseInTempDir we create a temporary directory based on the test
2224
name and then create two subdirs - test and home under it.
2226
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2228
for i in range(100):
2229
if os.path.exists(name):
2230
name = name_prefix + '_' + str(i)
2234
# now create test and home directories within this dir
2235
self.test_base_dir = name
2236
self.test_home_dir = self.test_base_dir + '/home'
2237
os.mkdir(self.test_home_dir)
2238
self.test_dir = self.test_base_dir + '/work'
2239
os.mkdir(self.test_dir)
2240
os.chdir(self.test_dir)
2241
# put name of test inside
2242
f = file(self.test_base_dir + '/name', 'w')
2247
self.addCleanup(self.deleteTestDir)
2249
def deleteTestDir(self):
2250
os.chdir(self.TEST_ROOT)
2251
_rmtree_temp_dir(self.test_base_dir)
2253
def build_tree(self, shape, line_endings='binary', transport=None):
2254
"""Build a test tree according to a pattern.
2256
shape is a sequence of file specifications. If the final
2257
character is '/', a directory is created.
2259
This assumes that all the elements in the tree being built are new.
2261
This doesn't add anything to a branch.
2263
:type shape: list or tuple.
2264
:param line_endings: Either 'binary' or 'native'
2265
in binary mode, exact contents are written in native mode, the
2266
line endings match the default platform endings.
2267
:param transport: A transport to write to, for building trees on VFS's.
2268
If the transport is readonly or None, "." is opened automatically.
2271
if type(shape) not in (list, tuple):
2272
raise AssertionError("Parameter 'shape' should be "
2273
"a list or a tuple. Got %r instead" % (shape,))
2274
# It's OK to just create them using forward slashes on windows.
2275
if transport is None or transport.is_readonly():
2276
transport = get_transport(".")
2278
self.assertIsInstance(name, basestring)
2280
transport.mkdir(urlutils.escape(name[:-1]))
2282
if line_endings == 'binary':
2284
elif line_endings == 'native':
2287
raise errors.BzrError(
2288
'Invalid line ending request %r' % line_endings)
2289
content = "contents of %s%s" % (name.encode('utf-8'), end)
2290
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2292
def build_tree_contents(self, shape):
2293
build_tree_contents(shape)
2295
def assertInWorkingTree(self, path, root_path='.', tree=None):
2296
"""Assert whether path or paths are in the WorkingTree"""
2298
tree = workingtree.WorkingTree.open(root_path)
2299
if not isinstance(path, basestring):
2301
self.assertInWorkingTree(p, tree=tree)
2303
self.assertIsNot(tree.path2id(path), None,
2304
path+' not in working tree.')
2306
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2307
"""Assert whether path or paths are not in the WorkingTree"""
2309
tree = workingtree.WorkingTree.open(root_path)
2310
if not isinstance(path, basestring):
2312
self.assertNotInWorkingTree(p,tree=tree)
2314
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2317
class TestCaseWithTransport(TestCaseInTempDir):
2318
"""A test case that provides get_url and get_readonly_url facilities.
2320
These back onto two transport servers, one for readonly access and one for
2323
If no explicit class is provided for readonly access, a
2324
ReadonlyTransportDecorator is used instead which allows the use of non disk
2325
based read write transports.
2327
If an explicit class is provided for readonly access, that server and the
2328
readwrite one must both define get_url() as resolving to os.getcwd().
2331
def get_vfs_only_server(self):
2332
"""See TestCaseWithMemoryTransport.
2334
This is useful for some tests with specific servers that need
2337
if self.__vfs_server is None:
2338
self.__vfs_server = self.vfs_transport_factory()
2339
self.__vfs_server.setUp()
2340
self.addCleanup(self.__vfs_server.tearDown)
2341
return self.__vfs_server
2343
def make_branch_and_tree(self, relpath, format=None):
2344
"""Create a branch on the transport and a tree locally.
2346
If the transport is not a LocalTransport, the Tree can't be created on
2347
the transport. In that case if the vfs_transport_factory is
2348
LocalURLServer the working tree is created in the local
2349
directory backing the transport, and the returned tree's branch and
2350
repository will also be accessed locally. Otherwise a lightweight
2351
checkout is created and returned.
2353
:param format: The BzrDirFormat.
2354
:returns: the WorkingTree.
2356
# TODO: always use the local disk path for the working tree,
2357
# this obviously requires a format that supports branch references
2358
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2360
b = self.make_branch(relpath, format=format)
2362
return b.bzrdir.create_workingtree()
2363
except errors.NotLocalUrl:
2364
# We can only make working trees locally at the moment. If the
2365
# transport can't support them, then we keep the non-disk-backed
2366
# branch and create a local checkout.
2367
if self.vfs_transport_factory is LocalURLServer:
2368
# the branch is colocated on disk, we cannot create a checkout.
2369
# hopefully callers will expect this.
2370
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2371
wt = local_controldir.create_workingtree()
2372
if wt.branch._format != b._format:
2374
# Make sure that assigning to wt._branch fixes wt.branch,
2375
# in case the implementation details of workingtree objects
2377
self.assertIs(b, wt.branch)
2380
return b.create_checkout(relpath, lightweight=True)
2382
def assertIsDirectory(self, relpath, transport):
2383
"""Assert that relpath within transport is a directory.
2385
This may not be possible on all transports; in that case it propagates
2386
a TransportNotPossible.
2389
mode = transport.stat(relpath).st_mode
2390
except errors.NoSuchFile:
2391
self.fail("path %s is not a directory; no such file"
2393
if not stat.S_ISDIR(mode):
2394
self.fail("path %s is not a directory; has mode %#o"
2397
def assertTreesEqual(self, left, right):
2398
"""Check that left and right have the same content and properties."""
2399
# we use a tree delta to check for equality of the content, and we
2400
# manually check for equality of other things such as the parents list.
2401
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2402
differences = left.changes_from(right)
2403
self.assertFalse(differences.has_changed(),
2404
"Trees %r and %r are different: %r" % (left, right, differences))
2407
super(TestCaseWithTransport, self).setUp()
2408
self.__vfs_server = None
2411
class ChrootedTestCase(TestCaseWithTransport):
2412
"""A support class that provides readonly urls outside the local namespace.
2414
This is done by checking if self.transport_server is a MemoryServer. if it
2415
is then we are chrooted already, if it is not then an HttpServer is used
2418
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2419
be used without needed to redo it when a different
2420
subclass is in use ?
2424
super(ChrootedTestCase, self).setUp()
2425
if not self.vfs_transport_factory == MemoryServer:
2426
self.transport_readonly_server = HttpServer
2429
def condition_id_re(pattern):
2430
"""Create a condition filter which performs a re check on a test's id.
2432
:param pattern: A regular expression string.
2433
:return: A callable that returns True if the re matches.
2435
filter_re = re.compile(pattern)
2436
def condition(test):
2438
return filter_re.search(test_id)
2442
def condition_isinstance(klass_or_klass_list):
2443
"""Create a condition filter which returns isinstance(param, klass).
2445
:return: A callable which when called with one parameter obj return the
2446
result of isinstance(obj, klass_or_klass_list).
2449
return isinstance(obj, klass_or_klass_list)
2453
def condition_id_in_list(id_list):
2454
"""Create a condition filter which verify that test's id in a list.
2456
:param id_list: A TestIdList object.
2457
:return: A callable that returns True if the test's id appears in the list.
2459
def condition(test):
2460
return id_list.includes(test.id())
2464
def condition_id_startswith(starts):
2465
"""Create a condition filter verifying that test's id starts with a string.
2467
:param starts: A list of string.
2468
:return: A callable that returns True if the test's id starts with one of
2471
def condition(test):
2472
for start in starts:
2473
if test.id().startswith(start):
2479
def exclude_tests_by_condition(suite, condition):
2480
"""Create a test suite which excludes some tests from suite.
2482
:param suite: The suite to get tests from.
2483
:param condition: A callable whose result evaluates True when called with a
2484
test case which should be excluded from the result.
2485
:return: A suite which contains the tests found in suite that fail
2489
for test in iter_suite_tests(suite):
2490
if not condition(test):
2492
return TestUtil.TestSuite(result)
2495
def filter_suite_by_condition(suite, condition):
2496
"""Create a test suite by filtering another one.
2498
:param suite: The source suite.
2499
:param condition: A callable whose result evaluates True when called with a
2500
test case which should be included in the result.
2501
:return: A suite which contains the tests found in suite that pass
2505
for test in iter_suite_tests(suite):
2508
return TestUtil.TestSuite(result)
2511
def filter_suite_by_re(suite, pattern):
2512
"""Create a test suite by filtering another one.
2514
:param suite: the source suite
2515
:param pattern: pattern that names must match
2516
:returns: the newly created suite
2518
condition = condition_id_re(pattern)
2519
result_suite = filter_suite_by_condition(suite, condition)
2523
def filter_suite_by_id_list(suite, test_id_list):
2524
"""Create a test suite by filtering another one.
2526
:param suite: The source suite.
2527
:param test_id_list: A list of the test ids to keep as strings.
2528
:returns: the newly created suite
2530
condition = condition_id_in_list(test_id_list)
2531
result_suite = filter_suite_by_condition(suite, condition)
2535
def filter_suite_by_id_startswith(suite, start):
2536
"""Create a test suite by filtering another one.
2538
:param suite: The source suite.
2539
:param start: A list of string the test id must start with one of.
2540
:returns: the newly created suite
2542
condition = condition_id_startswith(start)
2543
result_suite = filter_suite_by_condition(suite, condition)
2547
def exclude_tests_by_re(suite, pattern):
2548
"""Create a test suite which excludes some tests from suite.
2550
:param suite: The suite to get tests from.
2551
:param pattern: A regular expression string. Test ids that match this
2552
pattern will be excluded from the result.
2553
:return: A TestSuite that contains all the tests from suite without the
2554
tests that matched pattern. The order of tests is the same as it was in
2557
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2560
def preserve_input(something):
2561
"""A helper for performing test suite transformation chains.
2563
:param something: Anything you want to preserve.
2569
def randomize_suite(suite):
2570
"""Return a new TestSuite with suite's tests in random order.
2572
The tests in the input suite are flattened into a single suite in order to
2573
accomplish this. Any nested TestSuites are removed to provide global
2576
tests = list(iter_suite_tests(suite))
2577
random.shuffle(tests)
2578
return TestUtil.TestSuite(tests)
2581
def split_suite_by_condition(suite, condition):
2582
"""Split a test suite into two by a condition.
2584
:param suite: The suite to split.
2585
:param condition: The condition to match on. Tests that match this
2586
condition are returned in the first test suite, ones that do not match
2587
are in the second suite.
2588
:return: A tuple of two test suites, where the first contains tests from
2589
suite matching the condition, and the second contains the remainder
2590
from suite. The order within each output suite is the same as it was in
2595
for test in iter_suite_tests(suite):
2597
matched.append(test)
2599
did_not_match.append(test)
2600
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2603
def split_suite_by_re(suite, pattern):
2604
"""Split a test suite into two by a regular expression.
2606
:param suite: The suite to split.
2607
:param pattern: A regular expression string. Test ids that match this
2608
pattern will be in the first test suite returned, and the others in the
2609
second test suite returned.
2610
:return: A tuple of two test suites, where the first contains tests from
2611
suite matching pattern, and the second contains the remainder from
2612
suite. The order within each output suite is the same as it was in
2615
return split_suite_by_condition(suite, condition_id_re(pattern))
2618
def run_suite(suite, name='test', verbose=False, pattern=".*",
2619
stop_on_failure=False,
2620
transport=None, lsprof_timed=None, bench_history=None,
2621
matching_tests_first=None,
2624
exclude_pattern=None,
2627
"""Run a test suite for bzr selftest.
2629
:param runner_class: The class of runner to use. Must support the
2630
constructor arguments passed by run_suite which are more than standard
2632
:return: A boolean indicating success.
2634
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2639
if runner_class is None:
2640
runner_class = TextTestRunner
2641
runner = runner_class(stream=sys.stdout,
2643
verbosity=verbosity,
2644
bench_history=bench_history,
2645
list_only=list_only,
2647
runner.stop_on_failure=stop_on_failure
2648
# Initialise the random number generator and display the seed used.
2649
# We convert the seed to a long to make it reuseable across invocations.
2650
random_order = False
2651
if random_seed is not None:
2653
if random_seed == "now":
2654
random_seed = long(time.time())
2656
# Convert the seed to a long if we can
2658
random_seed = long(random_seed)
2661
runner.stream.writeln("Randomizing test order using seed %s\n" %
2663
random.seed(random_seed)
2664
# Customise the list of tests if requested
2665
if exclude_pattern is not None:
2666
suite = exclude_tests_by_re(suite, exclude_pattern)
2668
order_changer = randomize_suite
2670
order_changer = preserve_input
2671
if pattern != '.*' or random_order:
2672
if matching_tests_first:
2673
suites = map(order_changer, split_suite_by_re(suite, pattern))
2674
suite = TestUtil.TestSuite(suites)
2676
suite = order_changer(filter_suite_by_re(suite, pattern))
2678
result = runner.run(suite)
2681
return result.wasStrictlySuccessful()
2683
return result.wasSuccessful()
2686
# Controlled by "bzr selftest -E=..." option
2687
selftest_debug_flags = set()
2690
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2692
test_suite_factory=None,
2695
matching_tests_first=None,
2698
exclude_pattern=None,
2705
"""Run the whole test suite under the enhanced runner"""
2706
# XXX: Very ugly way to do this...
2707
# Disable warning about old formats because we don't want it to disturb
2708
# any blackbox tests.
2709
from bzrlib import repository
2710
repository._deprecation_warning_done = True
2712
global default_transport
2713
if transport is None:
2714
transport = default_transport
2715
old_transport = default_transport
2716
default_transport = transport
2717
global selftest_debug_flags
2718
old_debug_flags = selftest_debug_flags
2719
if debug_flags is not None:
2720
selftest_debug_flags = set(debug_flags)
2722
if load_list is None:
2725
keep_only = load_test_id_list(load_list)
2726
if test_suite_factory is None:
2727
suite = test_suite(keep_only, starting_with)
2729
suite = test_suite_factory()
2730
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2731
stop_on_failure=stop_on_failure,
2732
transport=transport,
2733
lsprof_timed=lsprof_timed,
2734
bench_history=bench_history,
2735
matching_tests_first=matching_tests_first,
2736
list_only=list_only,
2737
random_seed=random_seed,
2738
exclude_pattern=exclude_pattern,
2740
runner_class=runner_class,
2743
default_transport = old_transport
2744
selftest_debug_flags = old_debug_flags
2747
def load_test_id_list(file_name):
2748
"""Load a test id list from a text file.
2750
The format is one test id by line. No special care is taken to impose
2751
strict rules, these test ids are used to filter the test suite so a test id
2752
that do not match an existing test will do no harm. This allows user to add
2753
comments, leave blank lines, etc.
2757
ftest = open(file_name, 'rt')
2759
if e.errno != errno.ENOENT:
2762
raise errors.NoSuchFile(file_name)
2764
for test_name in ftest.readlines():
2765
test_list.append(test_name.strip())
2770
def suite_matches_id_list(test_suite, id_list):
2771
"""Warns about tests not appearing or appearing more than once.
2773
:param test_suite: A TestSuite object.
2774
:param test_id_list: The list of test ids that should be found in
2777
:return: (absents, duplicates) absents is a list containing the test found
2778
in id_list but not in test_suite, duplicates is a list containing the
2779
test found multiple times in test_suite.
2781
When using a prefined test id list, it may occurs that some tests do not
2782
exist anymore or that some tests use the same id. This function warns the
2783
tester about potential problems in his workflow (test lists are volatile)
2784
or in the test suite itself (using the same id for several tests does not
2785
help to localize defects).
2787
# Build a dict counting id occurrences
2789
for test in iter_suite_tests(test_suite):
2791
tests[id] = tests.get(id, 0) + 1
2796
occurs = tests.get(id, 0)
2798
not_found.append(id)
2800
duplicates.append(id)
2802
return not_found, duplicates
2805
class TestIdList(object):
2806
"""Test id list to filter a test suite.
2808
Relying on the assumption that test ids are built as:
2809
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2810
notation, this class offers methods to :
2811
- avoid building a test suite for modules not refered to in the test list,
2812
- keep only the tests listed from the module test suite.
2815
def __init__(self, test_id_list):
2816
# When a test suite needs to be filtered against us we compare test ids
2817
# for equality, so a simple dict offers a quick and simple solution.
2818
self.tests = dict().fromkeys(test_id_list, True)
2820
# While unittest.TestCase have ids like:
2821
# <module>.<class>.<method>[(<param+)],
2822
# doctest.DocTestCase can have ids like:
2825
# <module>.<function>
2826
# <module>.<class>.<method>
2828
# Since we can't predict a test class from its name only, we settle on
2829
# a simple constraint: a test id always begins with its module name.
2832
for test_id in test_id_list:
2833
parts = test_id.split('.')
2834
mod_name = parts.pop(0)
2835
modules[mod_name] = True
2837
mod_name += '.' + part
2838
modules[mod_name] = True
2839
self.modules = modules
2841
def refers_to(self, module_name):
2842
"""Is there tests for the module or one of its sub modules."""
2843
return self.modules.has_key(module_name)
2845
def includes(self, test_id):
2846
return self.tests.has_key(test_id)
2849
class TestPrefixAliasRegistry(registry.Registry):
2850
"""A registry for test prefix aliases.
2852
This helps implement shorcuts for the --starting-with selftest
2853
option. Overriding existing prefixes is not allowed but not fatal (a
2854
warning will be emitted).
2857
def register(self, key, obj, help=None, info=None,
2858
override_existing=False):
2859
"""See Registry.register.
2861
Trying to override an existing alias causes a warning to be emitted,
2862
not a fatal execption.
2865
super(TestPrefixAliasRegistry, self).register(
2866
key, obj, help=help, info=info, override_existing=False)
2868
actual = self.get(key)
2869
note('Test prefix alias %s is already used for %s, ignoring %s'
2870
% (key, actual, obj))
2872
def resolve_alias(self, id_start):
2873
"""Replace the alias by the prefix in the given string.
2875
Using an unknown prefix is an error to help catching typos.
2877
parts = id_start.split('.')
2879
parts[0] = self.get(parts[0])
2881
raise errors.BzrCommandError(
2882
'%s is not a known test prefix alias' % parts[0])
2883
return '.'.join(parts)
2886
test_prefix_alias_registry = TestPrefixAliasRegistry()
2887
"""Registry of test prefix aliases."""
2890
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2891
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2892
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2894
# Obvious higest levels prefixes, feel free to add your own via a plugin
2895
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2896
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2897
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2898
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2899
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2902
def test_suite(keep_only=None, starting_with=None):
2903
"""Build and return TestSuite for the whole of bzrlib.
2905
:param keep_only: A list of test ids limiting the suite returned.
2907
:param starting_with: An id limiting the suite returned to the tests
2910
This function can be replaced if you need to change the default test
2911
suite on a global basis, but it is not encouraged.
2915
'bzrlib.tests.blackbox',
2916
'bzrlib.tests.branch_implementations',
2917
'bzrlib.tests.bzrdir_implementations',
2918
'bzrlib.tests.commands',
2919
'bzrlib.tests.interrepository_implementations',
2920
'bzrlib.tests.intertree_implementations',
2921
'bzrlib.tests.inventory_implementations',
2922
'bzrlib.tests.per_interbranch',
2923
'bzrlib.tests.per_lock',
2924
'bzrlib.tests.per_repository',
2925
'bzrlib.tests.per_repository_reference',
2926
'bzrlib.tests.test__dirstate_helpers',
2927
'bzrlib.tests.test__walkdirs_win32',
2928
'bzrlib.tests.test_ancestry',
2929
'bzrlib.tests.test_annotate',
2930
'bzrlib.tests.test_api',
2931
'bzrlib.tests.test_atomicfile',
2932
'bzrlib.tests.test_bad_files',
2933
'bzrlib.tests.test_bisect_multi',
2934
'bzrlib.tests.test_branch',
2935
'bzrlib.tests.test_branchbuilder',
2936
'bzrlib.tests.test_btree_index',
2937
'bzrlib.tests.test_bugtracker',
2938
'bzrlib.tests.test_bundle',
2939
'bzrlib.tests.test_bzrdir',
2940
'bzrlib.tests.test_cache_utf8',
2941
'bzrlib.tests.test_clean_tree',
2942
'bzrlib.tests.test_chunk_writer',
2943
'bzrlib.tests.test__chunks_to_lines',
2944
'bzrlib.tests.test_commands',
2945
'bzrlib.tests.test_commit',
2946
'bzrlib.tests.test_commit_merge',
2947
'bzrlib.tests.test_config',
2948
'bzrlib.tests.test_conflicts',
2949
'bzrlib.tests.test_counted_lock',
2950
'bzrlib.tests.test_decorators',
2951
'bzrlib.tests.test_delta',
2952
'bzrlib.tests.test_debug',
2953
'bzrlib.tests.test_deprecated_graph',
2954
'bzrlib.tests.test_diff',
2955
'bzrlib.tests.test_directory_service',
2956
'bzrlib.tests.test_dirstate',
2957
'bzrlib.tests.test_email_message',
2958
'bzrlib.tests.test_errors',
2959
'bzrlib.tests.test_export',
2960
'bzrlib.tests.test_extract',
2961
'bzrlib.tests.test_fetch',
2962
'bzrlib.tests.test_fifo_cache',
2963
'bzrlib.tests.test_filters',
2964
'bzrlib.tests.test_ftp_transport',
2965
'bzrlib.tests.test_foreign',
2966
'bzrlib.tests.test_generate_docs',
2967
'bzrlib.tests.test_generate_ids',
2968
'bzrlib.tests.test_globbing',
2969
'bzrlib.tests.test_gpg',
2970
'bzrlib.tests.test_graph',
2971
'bzrlib.tests.test_hashcache',
2972
'bzrlib.tests.test_help',
2973
'bzrlib.tests.test_hooks',
2974
'bzrlib.tests.test_http',
2975
'bzrlib.tests.test_http_implementations',
2976
'bzrlib.tests.test_http_response',
2977
'bzrlib.tests.test_https_ca_bundle',
2978
'bzrlib.tests.test_identitymap',
2979
'bzrlib.tests.test_ignores',
2980
'bzrlib.tests.test_index',
2981
'bzrlib.tests.test_info',
2982
'bzrlib.tests.test_inv',
2983
'bzrlib.tests.test_knit',
2984
'bzrlib.tests.test_lazy_import',
2985
'bzrlib.tests.test_lazy_regex',
2986
'bzrlib.tests.test_lockable_files',
2987
'bzrlib.tests.test_lockdir',
2988
'bzrlib.tests.test_log',
2989
'bzrlib.tests.test_lru_cache',
2990
'bzrlib.tests.test_lsprof',
2991
'bzrlib.tests.test_mail_client',
2992
'bzrlib.tests.test_memorytree',
2993
'bzrlib.tests.test_merge',
2994
'bzrlib.tests.test_merge3',
2995
'bzrlib.tests.test_merge_core',
2996
'bzrlib.tests.test_merge_directive',
2997
'bzrlib.tests.test_missing',
2998
'bzrlib.tests.test_msgeditor',
2999
'bzrlib.tests.test_multiparent',
3000
'bzrlib.tests.test_mutabletree',
3001
'bzrlib.tests.test_nonascii',
3002
'bzrlib.tests.test_options',
3003
'bzrlib.tests.test_osutils',
3004
'bzrlib.tests.test_osutils_encodings',
3005
'bzrlib.tests.test_pack',
3006
'bzrlib.tests.test_pack_repository',
3007
'bzrlib.tests.test_patch',
3008
'bzrlib.tests.test_patches',
3009
'bzrlib.tests.test_permissions',
3010
'bzrlib.tests.test_plugins',
3011
'bzrlib.tests.test_progress',
3012
'bzrlib.tests.test_read_bundle',
3013
'bzrlib.tests.test_reconcile',
3014
'bzrlib.tests.test_reconfigure',
3015
'bzrlib.tests.test_registry',
3016
'bzrlib.tests.test_remote',
3017
'bzrlib.tests.test_repository',
3018
'bzrlib.tests.test_revert',
3019
'bzrlib.tests.test_revision',
3020
'bzrlib.tests.test_revisionspec',
3021
'bzrlib.tests.test_revisiontree',
3022
'bzrlib.tests.test_rio',
3023
'bzrlib.tests.test_rules',
3024
'bzrlib.tests.test_sampler',
3025
'bzrlib.tests.test_selftest',
3026
'bzrlib.tests.test_setup',
3027
'bzrlib.tests.test_sftp_transport',
3028
'bzrlib.tests.test_shelf',
3029
'bzrlib.tests.test_shelf_ui',
3030
'bzrlib.tests.test_smart',
3031
'bzrlib.tests.test_smart_add',
3032
'bzrlib.tests.test_smart_request',
3033
'bzrlib.tests.test_smart_transport',
3034
'bzrlib.tests.test_smtp_connection',
3035
'bzrlib.tests.test_source',
3036
'bzrlib.tests.test_ssh_transport',
3037
'bzrlib.tests.test_status',
3038
'bzrlib.tests.test_store',
3039
'bzrlib.tests.test_strace',
3040
'bzrlib.tests.test_subsume',
3041
'bzrlib.tests.test_switch',
3042
'bzrlib.tests.test_symbol_versioning',
3043
'bzrlib.tests.test_tag',
3044
'bzrlib.tests.test_testament',
3045
'bzrlib.tests.test_textfile',
3046
'bzrlib.tests.test_textmerge',
3047
'bzrlib.tests.test_timestamp',
3048
'bzrlib.tests.test_trace',
3049
'bzrlib.tests.test_transactions',
3050
'bzrlib.tests.test_transform',
3051
'bzrlib.tests.test_transport',
3052
'bzrlib.tests.test_transport_implementations',
3053
'bzrlib.tests.test_transport_log',
3054
'bzrlib.tests.test_tree',
3055
'bzrlib.tests.test_treebuilder',
3056
'bzrlib.tests.test_tsort',
3057
'bzrlib.tests.test_tuned_gzip',
3058
'bzrlib.tests.test_ui',
3059
'bzrlib.tests.test_uncommit',
3060
'bzrlib.tests.test_upgrade',
3061
'bzrlib.tests.test_upgrade_stacked',
3062
'bzrlib.tests.test_urlutils',
3063
'bzrlib.tests.test_version',
3064
'bzrlib.tests.test_version_info',
3065
'bzrlib.tests.test_versionedfile',
3066
'bzrlib.tests.test_weave',
3067
'bzrlib.tests.test_whitebox',
3068
'bzrlib.tests.test_win32utils',
3069
'bzrlib.tests.test_workingtree',
3070
'bzrlib.tests.test_workingtree_4',
3071
'bzrlib.tests.test_wsgi',
3072
'bzrlib.tests.test_xml',
3073
'bzrlib.tests.tree_implementations',
3074
'bzrlib.tests.workingtree_implementations',
3075
'bzrlib.util.tests.test_bencode',
3078
loader = TestUtil.TestLoader()
3081
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3082
for start in starting_with]
3083
# We take precedence over keep_only because *at loading time* using
3084
# both options means we will load less tests for the same final result.
3085
def interesting_module(name):
3086
for start in starting_with:
3088
# Either the module name starts with the specified string
3089
name.startswith(start)
3090
# or it may contain tests starting with the specified string
3091
or start.startswith(name)
3095
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3097
elif keep_only is not None:
3098
id_filter = TestIdList(keep_only)
3099
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3100
def interesting_module(name):
3101
return id_filter.refers_to(name)
3104
loader = TestUtil.TestLoader()
3105
def interesting_module(name):
3106
# No filtering, all modules are interesting
3109
suite = loader.suiteClass()
3111
# modules building their suite with loadTestsFromModuleNames
3112
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3114
modules_to_doctest = [
3116
'bzrlib.branchbuilder',
3119
'bzrlib.iterablefile',
3123
'bzrlib.symbol_versioning',
3126
'bzrlib.version_info_formats.format_custom',
3129
for mod in modules_to_doctest:
3130
if not interesting_module(mod):
3131
# No tests to keep here, move along
3134
# note that this really does mean "report only" -- doctest
3135
# still runs the rest of the examples
3136
doc_suite = doctest.DocTestSuite(mod,
3137
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3138
except ValueError, e:
3139
print '**failed to get doctest for: %s\n%s' % (mod, e)
3141
if len(doc_suite._tests) == 0:
3142
raise errors.BzrError("no doctests found in %s" % (mod,))
3143
suite.addTest(doc_suite)
3145
default_encoding = sys.getdefaultencoding()
3146
for name, plugin in bzrlib.plugin.plugins().items():
3147
if not interesting_module(plugin.module.__name__):
3149
plugin_suite = plugin.test_suite()
3150
# We used to catch ImportError here and turn it into just a warning,
3151
# but really if you don't have --no-plugins this should be a failure.
3152
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3153
if plugin_suite is None:
3154
plugin_suite = plugin.load_plugin_tests(loader)
3155
if plugin_suite is not None:
3156
suite.addTest(plugin_suite)
3157
if default_encoding != sys.getdefaultencoding():
3158
bzrlib.trace.warning(
3159
'Plugin "%s" tried to reset default encoding to: %s', name,
3160
sys.getdefaultencoding())
3162
sys.setdefaultencoding(default_encoding)
3165
suite = filter_suite_by_id_startswith(suite, starting_with)
3167
if keep_only is not None:
3168
# Now that the referred modules have loaded their tests, keep only the
3170
suite = filter_suite_by_id_list(suite, id_filter)
3171
# Do some sanity checks on the id_list filtering
3172
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3174
# The tester has used both keep_only and starting_with, so he is
3175
# already aware that some tests are excluded from the list, there
3176
# is no need to tell him which.
3179
# Some tests mentioned in the list are not in the test suite. The
3180
# list may be out of date, report to the tester.
3181
for id in not_found:
3182
bzrlib.trace.warning('"%s" not found in the test suite', id)
3183
for id in duplicates:
3184
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3189
def multiply_scenarios(scenarios_left, scenarios_right):
3190
"""Multiply two sets of scenarios.
3192
:returns: the cartesian product of the two sets of scenarios, that is
3193
a scenario for every possible combination of a left scenario and a
3197
('%s,%s' % (left_name, right_name),
3198
dict(left_dict.items() + right_dict.items()))
3199
for left_name, left_dict in scenarios_left
3200
for right_name, right_dict in scenarios_right]
3203
def multiply_tests(tests, scenarios, result):
3204
"""Multiply tests_list by scenarios into result.
3206
This is the core workhorse for test parameterisation.
3208
Typically the load_tests() method for a per-implementation test suite will
3209
call multiply_tests and return the result.
3211
:param tests: The tests to parameterise.
3212
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3213
scenario_param_dict).
3214
:param result: A TestSuite to add created tests to.
3216
This returns the passed in result TestSuite with the cross product of all
3217
the tests repeated once for each scenario. Each test is adapted by adding
3218
the scenario name at the end of its id(), and updating the test object's
3219
__dict__ with the scenario_param_dict.
3221
>>> r = multiply_tests(
3222
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3223
... [('one', dict(param=1)),
3224
... ('two', dict(param=2))],
3226
>>> tests = list(iter_suite_tests(r))
3230
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3236
for test in iter_suite_tests(tests):
3237
apply_scenarios(test, scenarios, result)
3241
def apply_scenarios(test, scenarios, result):
3242
"""Apply the scenarios in scenarios to test and add to result.
3244
:param test: The test to apply scenarios to.
3245
:param scenarios: An iterable of scenarios to apply to test.
3247
:seealso: apply_scenario
3249
for scenario in scenarios:
3250
result.addTest(apply_scenario(test, scenario))
3254
def apply_scenario(test, scenario):
3255
"""Copy test and apply scenario to it.
3257
:param test: A test to adapt.
3258
:param scenario: A tuple describing the scenarion.
3259
The first element of the tuple is the new test id.
3260
The second element is a dict containing attributes to set on the
3262
:return: The adapted test.
3264
new_id = "%s(%s)" % (test.id(), scenario[0])
3265
new_test = clone_test(test, new_id)
3266
for name, value in scenario[1].items():
3267
setattr(new_test, name, value)
3271
def clone_test(test, new_id):
3272
"""Clone a test giving it a new id.
3274
:param test: The test to clone.
3275
:param new_id: The id to assign to it.
3276
:return: The new test.
3278
from copy import deepcopy
3279
new_test = deepcopy(test)
3280
new_test.id = lambda: new_id
3284
def _rmtree_temp_dir(dirname):
3285
# If LANG=C we probably have created some bogus paths
3286
# which rmtree(unicode) will fail to delete
3287
# so make sure we are using rmtree(str) to delete everything
3288
# except on win32, where rmtree(str) will fail
3289
# since it doesn't have the property of byte-stream paths
3290
# (they are either ascii or mbcs)
3291
if sys.platform == 'win32':
3292
# make sure we are using the unicode win32 api
3293
dirname = unicode(dirname)
3295
dirname = dirname.encode(sys.getfilesystemencoding())
3297
osutils.rmtree(dirname)
3299
if sys.platform == 'win32' and e.errno == errno.EACCES:
3300
sys.stderr.write(('Permission denied: '
3301
'unable to remove testing dir '
3302
'%s\n' % os.path.basename(dirname)))
3307
class Feature(object):
3308
"""An operating system Feature."""
3311
self._available = None
3313
def available(self):
3314
"""Is the feature available?
3316
:return: True if the feature is available.
3318
if self._available is None:
3319
self._available = self._probe()
3320
return self._available
3323
"""Implement this method in concrete features.
3325
:return: True if the feature is available.
3327
raise NotImplementedError
3330
if getattr(self, 'feature_name', None):
3331
return self.feature_name()
3332
return self.__class__.__name__
3335
class _SymlinkFeature(Feature):
3338
return osutils.has_symlinks()
3340
def feature_name(self):
3343
SymlinkFeature = _SymlinkFeature()
3346
class _HardlinkFeature(Feature):
3349
return osutils.has_hardlinks()
3351
def feature_name(self):
3354
HardlinkFeature = _HardlinkFeature()
3357
class _OsFifoFeature(Feature):
3360
return getattr(os, 'mkfifo', None)
3362
def feature_name(self):
3363
return 'filesystem fifos'
3365
OsFifoFeature = _OsFifoFeature()
3368
class _UnicodeFilenameFeature(Feature):
3369
"""Does the filesystem support Unicode filenames?"""
3373
# Check for character combinations unlikely to be covered by any
3374
# single non-unicode encoding. We use the characters
3375
# - greek small letter alpha (U+03B1) and
3376
# - braille pattern dots-123456 (U+283F).
3377
os.stat(u'\u03b1\u283f')
3378
except UnicodeEncodeError:
3380
except (IOError, OSError):
3381
# The filesystem allows the Unicode filename but the file doesn't
3385
# The filesystem allows the Unicode filename and the file exists,
3389
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3392
def probe_unicode_in_user_encoding():
3393
"""Try to encode several unicode strings to use in unicode-aware tests.
3394
Return first successfull match.
3396
:return: (unicode value, encoded plain string value) or (None, None)
3398
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3399
for uni_val in possible_vals:
3401
str_val = uni_val.encode(osutils.get_user_encoding())
3402
except UnicodeEncodeError:
3403
# Try a different character
3406
return uni_val, str_val
3410
def probe_bad_non_ascii(encoding):
3411
"""Try to find [bad] character with code [128..255]
3412
that cannot be decoded to unicode in some encoding.
3413
Return None if all non-ascii characters is valid
3416
for i in xrange(128, 256):
3419
char.decode(encoding)
3420
except UnicodeDecodeError:
3425
class _HTTPSServerFeature(Feature):
3426
"""Some tests want an https Server, check if one is available.
3428
Right now, the only way this is available is under python2.6 which provides
3439
def feature_name(self):
3440
return 'HTTPSServer'
3443
HTTPSServerFeature = _HTTPSServerFeature()
3446
class _UnicodeFilename(Feature):
3447
"""Does the filesystem support Unicode filenames?"""
3452
except UnicodeEncodeError:
3454
except (IOError, OSError):
3455
# The filesystem allows the Unicode filename but the file doesn't
3459
# The filesystem allows the Unicode filename and the file exists,
3463
UnicodeFilename = _UnicodeFilename()
3466
class _UTF8Filesystem(Feature):
3467
"""Is the filesystem UTF-8?"""
3470
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3474
UTF8Filesystem = _UTF8Filesystem()
3477
class _CaseInsCasePresFilenameFeature(Feature):
3478
"""Is the file-system case insensitive, but case-preserving?"""
3481
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3483
# first check truly case-preserving for created files, then check
3484
# case insensitive when opening existing files.
3485
name = osutils.normpath(name)
3486
base, rel = osutils.split(name)
3487
found_rel = osutils.canonical_relpath(base, name)
3488
return (found_rel == rel
3489
and os.path.isfile(name.upper())
3490
and os.path.isfile(name.lower()))
3495
def feature_name(self):
3496
return "case-insensitive case-preserving filesystem"
3498
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3501
class _CaseInsensitiveFilesystemFeature(Feature):
3502
"""Check if underlying filesystem is case-insensitive but *not* case
3505
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3506
# more likely to be case preserving, so this case is rare.
3509
if CaseInsCasePresFilenameFeature.available():
3512
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3513
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3514
TestCaseWithMemoryTransport.TEST_ROOT = root
3516
root = TestCaseWithMemoryTransport.TEST_ROOT
3517
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3519
name_a = osutils.pathjoin(tdir, 'a')
3520
name_A = osutils.pathjoin(tdir, 'A')
3522
result = osutils.isdir(name_A)
3523
_rmtree_temp_dir(tdir)
3526
def feature_name(self):
3527
return 'case-insensitive filesystem'
3529
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3532
class _SubUnitFeature(Feature):
3533
"""Check if subunit is available."""
3542
def feature_name(self):
3545
SubUnitFeature = _SubUnitFeature()
3546
# Only define SubUnitBzrRunner if subunit is available.
3548
from subunit import TestProtocolClient
3549
class SubUnitBzrRunner(TextTestRunner):
3550
def run(self, test):
3551
# undo out claim for testing which looks like a test start to subunit
3552
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3553
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
