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 (%o != %o)' % (path, mode, actual_mode))
1022
def assertIsSameRealPath(self, path1, path2):
1023
"""Fail if path1 and path2 points to different files"""
1024
self.assertEqual(osutils.realpath(path1),
1025
osutils.realpath(path2),
1026
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1028
def assertIsInstance(self, obj, kls):
1029
"""Fail if obj is not an instance of kls"""
1030
if not isinstance(obj, kls):
1031
self.fail("%r is an instance of %s rather than %s" % (
1032
obj, obj.__class__, kls))
1034
def expectFailure(self, reason, assertion, *args, **kwargs):
1035
"""Invoke a test, expecting it to fail for the given reason.
1037
This is for assertions that ought to succeed, but currently fail.
1038
(The failure is *expected* but not *wanted*.) Please be very precise
1039
about the failure you're expecting. If a new bug is introduced,
1040
AssertionError should be raised, not KnownFailure.
1042
Frequently, expectFailure should be followed by an opposite assertion.
1045
Intended to be used with a callable that raises AssertionError as the
1046
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1048
Raises KnownFailure if the test fails. Raises AssertionError if the
1053
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1055
self.assertEqual(42, dynamic_val)
1057
This means that a dynamic_val of 54 will cause the test to raise
1058
a KnownFailure. Once math is fixed and the expectFailure is removed,
1059
only a dynamic_val of 42 will allow the test to pass. Anything other
1060
than 54 or 42 will cause an AssertionError.
1063
assertion(*args, **kwargs)
1064
except AssertionError:
1065
raise KnownFailure(reason)
1067
self.fail('Unexpected success. Should have failed: %s' % reason)
1069
def assertFileEqual(self, content, path):
1070
"""Fail if path does not contain 'content'."""
1071
self.failUnlessExists(path)
1072
f = file(path, 'rb')
1077
self.assertEqualDiff(content, s)
1079
def failUnlessExists(self, path):
1080
"""Fail unless path or paths, which may be abs or relative, exist."""
1081
if not isinstance(path, basestring):
1083
self.failUnlessExists(p)
1085
self.failUnless(osutils.lexists(path),path+" does not exist")
1087
def failIfExists(self, path):
1088
"""Fail if path or paths, which may be abs or relative, exist."""
1089
if not isinstance(path, basestring):
1091
self.failIfExists(p)
1093
self.failIf(osutils.lexists(path),path+" exists")
1095
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1096
"""A helper for callDeprecated and applyDeprecated.
1098
:param a_callable: A callable to call.
1099
:param args: The positional arguments for the callable
1100
:param kwargs: The keyword arguments for the callable
1101
:return: A tuple (warnings, result). result is the result of calling
1102
a_callable(``*args``, ``**kwargs``).
1105
def capture_warnings(msg, cls=None, stacklevel=None):
1106
# we've hooked into a deprecation specific callpath,
1107
# only deprecations should getting sent via it.
1108
self.assertEqual(cls, DeprecationWarning)
1109
local_warnings.append(msg)
1110
original_warning_method = symbol_versioning.warn
1111
symbol_versioning.set_warning_method(capture_warnings)
1113
result = a_callable(*args, **kwargs)
1115
symbol_versioning.set_warning_method(original_warning_method)
1116
return (local_warnings, result)
1118
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1119
"""Call a deprecated callable without warning the user.
1121
Note that this only captures warnings raised by symbol_versioning.warn,
1122
not other callers that go direct to the warning module.
1124
To test that a deprecated method raises an error, do something like
1127
self.assertRaises(errors.ReservedId,
1128
self.applyDeprecated,
1129
deprecated_in((1, 5, 0)),
1133
:param deprecation_format: The deprecation format that the callable
1134
should have been deprecated with. This is the same type as the
1135
parameter to deprecated_method/deprecated_function. If the
1136
callable is not deprecated with this format, an assertion error
1138
:param a_callable: A callable to call. This may be a bound method or
1139
a regular function. It will be called with ``*args`` and
1141
:param args: The positional arguments for the callable
1142
:param kwargs: The keyword arguments for the callable
1143
:return: The result of a_callable(``*args``, ``**kwargs``)
1145
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1147
expected_first_warning = symbol_versioning.deprecation_string(
1148
a_callable, deprecation_format)
1149
if len(call_warnings) == 0:
1150
self.fail("No deprecation warning generated by call to %s" %
1152
self.assertEqual(expected_first_warning, call_warnings[0])
1155
def callCatchWarnings(self, fn, *args, **kw):
1156
"""Call a callable that raises python warnings.
1158
The caller's responsible for examining the returned warnings.
1160
If the callable raises an exception, the exception is not
1161
caught and propagates up to the caller. In that case, the list
1162
of warnings is not available.
1164
:returns: ([warning_object, ...], fn_result)
1166
# XXX: This is not perfect, because it completely overrides the
1167
# warnings filters, and some code may depend on suppressing particular
1168
# warnings. It's the easiest way to insulate ourselves from -Werror,
1169
# though. -- Andrew, 20071062
1171
def _catcher(message, category, filename, lineno, file=None, line=None):
1172
# despite the name, 'message' is normally(?) a Warning subclass
1174
wlist.append(message)
1175
saved_showwarning = warnings.showwarning
1176
saved_filters = warnings.filters
1178
warnings.showwarning = _catcher
1179
warnings.filters = []
1180
result = fn(*args, **kw)
1182
warnings.showwarning = saved_showwarning
1183
warnings.filters = saved_filters
1184
return wlist, result
1186
def callDeprecated(self, expected, callable, *args, **kwargs):
1187
"""Assert that a callable is deprecated in a particular way.
1189
This is a very precise test for unusual requirements. The
1190
applyDeprecated helper function is probably more suited for most tests
1191
as it allows you to simply specify the deprecation format being used
1192
and will ensure that that is issued for the function being called.
1194
Note that this only captures warnings raised by symbol_versioning.warn,
1195
not other callers that go direct to the warning module. To catch
1196
general warnings, use callCatchWarnings.
1198
:param expected: a list of the deprecation warnings expected, in order
1199
:param callable: The callable to call
1200
:param args: The positional arguments for the callable
1201
:param kwargs: The keyword arguments for the callable
1203
call_warnings, result = self._capture_deprecation_warnings(callable,
1205
self.assertEqual(expected, call_warnings)
1208
def _startLogFile(self):
1209
"""Send bzr and test log messages to a temporary file.
1211
The file is removed as the test is torn down.
1213
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1214
self._log_file = os.fdopen(fileno, 'w+')
1215
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1216
self._log_file_name = name
1217
self.addCleanup(self._finishLogFile)
1219
def _finishLogFile(self):
1220
"""Finished with the log file.
1222
Close the file and delete it, unless setKeepLogfile was called.
1224
if self._log_file is None:
1226
bzrlib.trace.pop_log_file(self._log_memento)
1227
self._log_file.close()
1228
self._log_file = None
1229
if not self._keep_log_file:
1230
os.remove(self._log_file_name)
1231
self._log_file_name = None
1233
def setKeepLogfile(self):
1234
"""Make the logfile not be deleted when _finishLogFile is called."""
1235
self._keep_log_file = True
1237
def addCleanup(self, callable, *args, **kwargs):
1238
"""Arrange to run a callable when this case is torn down.
1240
Callables are run in the reverse of the order they are registered,
1241
ie last-in first-out.
1243
self._cleanups.append((callable, args, kwargs))
1245
def _cleanEnvironment(self):
1247
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1248
'HOME': os.getcwd(),
1249
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1250
# tests do check our impls match APPDATA
1251
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1253
'BZREMAIL': None, # may still be present in the environment
1255
'BZR_PROGRESS_BAR': None,
1257
'BZR_PLUGIN_PATH': None,
1259
'SSH_AUTH_SOCK': None,
1263
'https_proxy': None,
1264
'HTTPS_PROXY': None,
1269
# Nobody cares about these ones AFAIK. So far at
1270
# least. If you do (care), please update this comment
1274
'BZR_REMOTE_PATH': None,
1277
self.addCleanup(self._restoreEnvironment)
1278
for name, value in new_env.iteritems():
1279
self._captureVar(name, value)
1281
def _captureVar(self, name, newvalue):
1282
"""Set an environment variable, and reset it when finished."""
1283
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1285
def _restore_debug_flags(self):
1286
debug.debug_flags.clear()
1287
debug.debug_flags.update(self._preserved_debug_flags)
1289
def _restoreEnvironment(self):
1290
for name, value in self.__old_env.iteritems():
1291
osutils.set_or_unset_env(name, value)
1293
def _restoreHooks(self):
1294
for klass, (name, hooks) in self._preserved_hooks.items():
1295
setattr(klass, name, hooks)
1297
def knownFailure(self, reason):
1298
"""This test has failed for some known reason."""
1299
raise KnownFailure(reason)
1301
def _do_skip(self, result, reason):
1302
addSkip = getattr(result, 'addSkip', None)
1303
if not callable(addSkip):
1304
result.addError(self, self.exc_info())
1306
addSkip(self, reason)
1308
def run(self, result=None):
1309
if result is None: result = self.defaultTestResult()
1310
for feature in getattr(self, '_test_needs_features', []):
1311
if not feature.available():
1312
result.startTest(self)
1313
if getattr(result, 'addNotSupported', None):
1314
result.addNotSupported(self, feature)
1316
result.addSuccess(self)
1317
result.stopTest(self)
1321
result.startTest(self)
1322
absent_attr = object()
1324
method_name = getattr(self, '_testMethodName', absent_attr)
1325
if method_name is absent_attr:
1327
method_name = getattr(self, '_TestCase__testMethodName')
1328
testMethod = getattr(self, method_name)
1332
if not self._bzr_test_setUp_run:
1334
"test setUp did not invoke "
1335
"bzrlib.tests.TestCase's setUp")
1336
except KeyboardInterrupt:
1338
except TestSkipped, e:
1339
self._do_skip(result, e.args[0])
1343
result.addError(self, self.exc_info())
1350
except self.failureException:
1351
result.addFailure(self, self.exc_info())
1352
except TestSkipped, e:
1354
reason = "No reason given."
1357
self._do_skip(result, reason)
1358
except KeyboardInterrupt:
1361
result.addError(self, self.exc_info())
1365
if not self._bzr_test_tearDown_run:
1367
"test tearDown did not invoke "
1368
"bzrlib.tests.TestCase's tearDown")
1369
except KeyboardInterrupt:
1372
result.addError(self, self.exc_info())
1374
if ok: result.addSuccess(self)
1376
result.stopTest(self)
1378
except TestNotApplicable:
1379
# Not moved from the result [yet].
1381
except KeyboardInterrupt:
1385
absent_attr = object()
1386
for attr_name in self.attrs_to_keep:
1387
attr = getattr(self, attr_name, absent_attr)
1388
if attr is not absent_attr:
1389
saved_attrs[attr_name] = attr
1390
self.__dict__ = saved_attrs
1393
self._bzr_test_tearDown_run = True
1395
self._log_contents = ''
1396
unittest.TestCase.tearDown(self)
1398
def time(self, callable, *args, **kwargs):
1399
"""Run callable and accrue the time it takes to the benchmark time.
1401
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1402
this will cause lsprofile statistics to be gathered and stored in
1405
if self._benchtime is None:
1409
if not self._gather_lsprof_in_benchmarks:
1410
return callable(*args, **kwargs)
1412
# record this benchmark
1413
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1415
self._benchcalls.append(((callable, args, kwargs), stats))
1418
self._benchtime += time.time() - start
1420
def _runCleanups(self):
1421
"""Run registered cleanup functions.
1423
This should only be called from TestCase.tearDown.
1425
# TODO: Perhaps this should keep running cleanups even if
1426
# one of them fails?
1428
# Actually pop the cleanups from the list so tearDown running
1429
# twice is safe (this happens for skipped tests).
1430
while self._cleanups:
1431
cleanup, args, kwargs = self._cleanups.pop()
1432
cleanup(*args, **kwargs)
1434
def log(self, *args):
1437
def _get_log(self, keep_log_file=False):
1438
"""Get the log from bzrlib.trace calls from this test.
1440
:param keep_log_file: When True, if the log is still a file on disk
1441
leave it as a file on disk. When False, if the log is still a file
1442
on disk, the log file is deleted and the log preserved as
1444
:return: A string containing the log.
1446
# flush the log file, to get all content
1448
if bzrlib.trace._trace_file:
1449
bzrlib.trace._trace_file.flush()
1450
if self._log_contents:
1451
# XXX: this can hardly contain the content flushed above --vila
1453
return self._log_contents
1454
if self._log_file_name is not None:
1455
logfile = open(self._log_file_name)
1457
log_contents = logfile.read()
1460
if not keep_log_file:
1461
self._log_contents = log_contents
1463
os.remove(self._log_file_name)
1465
if sys.platform == 'win32' and e.errno == errno.EACCES:
1466
sys.stderr.write(('Unable to delete log file '
1467
' %r\n' % self._log_file_name))
1472
return "DELETED log file to reduce memory footprint"
1474
def requireFeature(self, feature):
1475
"""This test requires a specific feature is available.
1477
:raises UnavailableFeature: When feature is not available.
1479
if not feature.available():
1480
raise UnavailableFeature(feature)
1482
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1484
"""Run bazaar command line, splitting up a string command line."""
1485
if isinstance(args, basestring):
1486
# shlex don't understand unicode strings,
1487
# so args should be plain string (bialix 20070906)
1488
args = list(shlex.split(str(args)))
1489
return self._run_bzr_core(args, retcode=retcode,
1490
encoding=encoding, stdin=stdin, working_dir=working_dir,
1493
def _run_bzr_core(self, args, retcode, encoding, stdin,
1495
if encoding is None:
1496
encoding = osutils.get_user_encoding()
1497
stdout = StringIOWrapper()
1498
stderr = StringIOWrapper()
1499
stdout.encoding = encoding
1500
stderr.encoding = encoding
1502
self.log('run bzr: %r', args)
1503
# FIXME: don't call into logging here
1504
handler = logging.StreamHandler(stderr)
1505
handler.setLevel(logging.INFO)
1506
logger = logging.getLogger('')
1507
logger.addHandler(handler)
1508
old_ui_factory = ui.ui_factory
1509
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1512
if working_dir is not None:
1513
cwd = osutils.getcwd()
1514
os.chdir(working_dir)
1517
result = self.apply_redirected(ui.ui_factory.stdin,
1519
bzrlib.commands.run_bzr_catch_user_errors,
1522
logger.removeHandler(handler)
1523
ui.ui_factory = old_ui_factory
1527
out = stdout.getvalue()
1528
err = stderr.getvalue()
1530
self.log('output:\n%r', out)
1532
self.log('errors:\n%r', err)
1533
if retcode is not None:
1534
self.assertEquals(retcode, result,
1535
message='Unexpected return code')
1538
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1539
working_dir=None, error_regexes=[], output_encoding=None):
1540
"""Invoke bzr, as if it were run from the command line.
1542
The argument list should not include the bzr program name - the
1543
first argument is normally the bzr command. Arguments may be
1544
passed in three ways:
1546
1- A list of strings, eg ["commit", "a"]. This is recommended
1547
when the command contains whitespace or metacharacters, or
1548
is built up at run time.
1550
2- A single string, eg "add a". This is the most convenient
1551
for hardcoded commands.
1553
This runs bzr through the interface that catches and reports
1554
errors, and with logging set to something approximating the
1555
default, so that error reporting can be checked.
1557
This should be the main method for tests that want to exercise the
1558
overall behavior of the bzr application (rather than a unit test
1559
or a functional test of the library.)
1561
This sends the stdout/stderr results into the test's log,
1562
where it may be useful for debugging. See also run_captured.
1564
:keyword stdin: A string to be used as stdin for the command.
1565
:keyword retcode: The status code the command should return;
1567
:keyword working_dir: The directory to run the command in
1568
:keyword error_regexes: A list of expected error messages. If
1569
specified they must be seen in the error output of the command.
1571
out, err = self._run_bzr_autosplit(
1576
working_dir=working_dir,
1578
for regex in error_regexes:
1579
self.assertContainsRe(err, regex)
1582
def run_bzr_error(self, error_regexes, *args, **kwargs):
1583
"""Run bzr, and check that stderr contains the supplied regexes
1585
:param error_regexes: Sequence of regular expressions which
1586
must each be found in the error output. The relative ordering
1588
:param args: command-line arguments for bzr
1589
:param kwargs: Keyword arguments which are interpreted by run_bzr
1590
This function changes the default value of retcode to be 3,
1591
since in most cases this is run when you expect bzr to fail.
1593
:return: (out, err) The actual output of running the command (in case
1594
you want to do more inspection)
1598
# Make sure that commit is failing because there is nothing to do
1599
self.run_bzr_error(['no changes to commit'],
1600
['commit', '-m', 'my commit comment'])
1601
# Make sure --strict is handling an unknown file, rather than
1602
# giving us the 'nothing to do' error
1603
self.build_tree(['unknown'])
1604
self.run_bzr_error(['Commit refused because there are unknown files'],
1605
['commit', --strict', '-m', 'my commit comment'])
1607
kwargs.setdefault('retcode', 3)
1608
kwargs['error_regexes'] = error_regexes
1609
out, err = self.run_bzr(*args, **kwargs)
1612
def run_bzr_subprocess(self, *args, **kwargs):
1613
"""Run bzr in a subprocess for testing.
1615
This starts a new Python interpreter and runs bzr in there.
1616
This should only be used for tests that have a justifiable need for
1617
this isolation: e.g. they are testing startup time, or signal
1618
handling, or early startup code, etc. Subprocess code can't be
1619
profiled or debugged so easily.
1621
:keyword retcode: The status code that is expected. Defaults to 0. If
1622
None is supplied, the status code is not checked.
1623
:keyword env_changes: A dictionary which lists changes to environment
1624
variables. A value of None will unset the env variable.
1625
The values must be strings. The change will only occur in the
1626
child, so you don't need to fix the environment after running.
1627
:keyword universal_newlines: Convert CRLF => LF
1628
:keyword allow_plugins: By default the subprocess is run with
1629
--no-plugins to ensure test reproducibility. Also, it is possible
1630
for system-wide plugins to create unexpected output on stderr,
1631
which can cause unnecessary test failures.
1633
env_changes = kwargs.get('env_changes', {})
1634
working_dir = kwargs.get('working_dir', None)
1635
allow_plugins = kwargs.get('allow_plugins', False)
1637
if isinstance(args[0], list):
1639
elif isinstance(args[0], basestring):
1640
args = list(shlex.split(args[0]))
1642
raise ValueError("passing varargs to run_bzr_subprocess")
1643
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1644
working_dir=working_dir,
1645
allow_plugins=allow_plugins)
1646
# We distinguish between retcode=None and retcode not passed.
1647
supplied_retcode = kwargs.get('retcode', 0)
1648
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1649
universal_newlines=kwargs.get('universal_newlines', False),
1652
def start_bzr_subprocess(self, process_args, env_changes=None,
1653
skip_if_plan_to_signal=False,
1655
allow_plugins=False):
1656
"""Start bzr in a subprocess for testing.
1658
This starts a new Python interpreter and runs bzr in there.
1659
This should only be used for tests that have a justifiable need for
1660
this isolation: e.g. they are testing startup time, or signal
1661
handling, or early startup code, etc. Subprocess code can't be
1662
profiled or debugged so easily.
1664
:param process_args: a list of arguments to pass to the bzr executable,
1665
for example ``['--version']``.
1666
:param env_changes: A dictionary which lists changes to environment
1667
variables. A value of None will unset the env variable.
1668
The values must be strings. The change will only occur in the
1669
child, so you don't need to fix the environment after running.
1670
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1672
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1674
:returns: Popen object for the started process.
1676
if skip_if_plan_to_signal:
1677
if not getattr(os, 'kill', None):
1678
raise TestSkipped("os.kill not available.")
1680
if env_changes is None:
1684
def cleanup_environment():
1685
for env_var, value in env_changes.iteritems():
1686
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1688
def restore_environment():
1689
for env_var, value in old_env.iteritems():
1690
osutils.set_or_unset_env(env_var, value)
1692
bzr_path = self.get_bzr_path()
1695
if working_dir is not None:
1696
cwd = osutils.getcwd()
1697
os.chdir(working_dir)
1700
# win32 subprocess doesn't support preexec_fn
1701
# so we will avoid using it on all platforms, just to
1702
# make sure the code path is used, and we don't break on win32
1703
cleanup_environment()
1704
command = [sys.executable]
1705
# frozen executables don't need the path to bzr
1706
if getattr(sys, "frozen", None) is None:
1707
command.append(bzr_path)
1708
if not allow_plugins:
1709
command.append('--no-plugins')
1710
command.extend(process_args)
1711
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1713
restore_environment()
1719
def _popen(self, *args, **kwargs):
1720
"""Place a call to Popen.
1722
Allows tests to override this method to intercept the calls made to
1723
Popen for introspection.
1725
return Popen(*args, **kwargs)
1727
def get_bzr_path(self):
1728
"""Return the path of the 'bzr' executable for this test suite."""
1729
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1730
if not os.path.isfile(bzr_path):
1731
# We are probably installed. Assume sys.argv is the right file
1732
bzr_path = sys.argv[0]
1735
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1736
universal_newlines=False, process_args=None):
1737
"""Finish the execution of process.
1739
:param process: the Popen object returned from start_bzr_subprocess.
1740
:param retcode: The status code that is expected. Defaults to 0. If
1741
None is supplied, the status code is not checked.
1742
:param send_signal: an optional signal to send to the process.
1743
:param universal_newlines: Convert CRLF => LF
1744
:returns: (stdout, stderr)
1746
if send_signal is not None:
1747
os.kill(process.pid, send_signal)
1748
out, err = process.communicate()
1750
if universal_newlines:
1751
out = out.replace('\r\n', '\n')
1752
err = err.replace('\r\n', '\n')
1754
if retcode is not None and retcode != process.returncode:
1755
if process_args is None:
1756
process_args = "(unknown args)"
1757
mutter('Output of bzr %s:\n%s', process_args, out)
1758
mutter('Error for bzr %s:\n%s', process_args, err)
1759
self.fail('Command bzr %s failed with retcode %s != %s'
1760
% (process_args, retcode, process.returncode))
1763
def check_inventory_shape(self, inv, shape):
1764
"""Compare an inventory to a list of expected names.
1766
Fail if they are not precisely equal.
1769
shape = list(shape) # copy
1770
for path, ie in inv.entries():
1771
name = path.replace('\\', '/')
1772
if ie.kind == 'directory':
1779
self.fail("expected paths not found in inventory: %r" % shape)
1781
self.fail("unexpected paths found in inventory: %r" % extras)
1783
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1784
a_callable=None, *args, **kwargs):
1785
"""Call callable with redirected std io pipes.
1787
Returns the return code."""
1788
if not callable(a_callable):
1789
raise ValueError("a_callable must be callable.")
1791
stdin = StringIO("")
1793
if getattr(self, "_log_file", None) is not None:
1794
stdout = self._log_file
1798
if getattr(self, "_log_file", None is not None):
1799
stderr = self._log_file
1802
real_stdin = sys.stdin
1803
real_stdout = sys.stdout
1804
real_stderr = sys.stderr
1809
return a_callable(*args, **kwargs)
1811
sys.stdout = real_stdout
1812
sys.stderr = real_stderr
1813
sys.stdin = real_stdin
1815
def reduceLockdirTimeout(self):
1816
"""Reduce the default lock timeout for the duration of the test, so that
1817
if LockContention occurs during a test, it does so quickly.
1819
Tests that expect to provoke LockContention errors should call this.
1821
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1823
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1824
self.addCleanup(resetTimeout)
1825
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1827
def make_utf8_encoded_stringio(self, encoding_type=None):
1828
"""Return a StringIOWrapper instance, that will encode Unicode
1831
if encoding_type is None:
1832
encoding_type = 'strict'
1834
output_encoding = 'utf-8'
1835
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1836
sio.encoding = output_encoding
1840
class CapturedCall(object):
1841
"""A helper for capturing smart server calls for easy debug analysis."""
1843
def __init__(self, params, prefix_length):
1844
"""Capture the call with params and skip prefix_length stack frames."""
1847
# The last 5 frames are the __init__, the hook frame, and 3 smart
1848
# client frames. Beyond this we could get more clever, but this is good
1850
stack = traceback.extract_stack()[prefix_length:-5]
1851
self.stack = ''.join(traceback.format_list(stack))
1854
return self.call.method
1857
return self.call.method
1863
class TestCaseWithMemoryTransport(TestCase):
1864
"""Common test class for tests that do not need disk resources.
1866
Tests that need disk resources should derive from TestCaseWithTransport.
1868
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1870
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1871
a directory which does not exist. This serves to help ensure test isolation
1872
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1873
must exist. However, TestCaseWithMemoryTransport does not offer local
1874
file defaults for the transport in tests, nor does it obey the command line
1875
override, so tests that accidentally write to the common directory should
1878
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1879
a .bzr directory that stops us ascending higher into the filesystem.
1885
def __init__(self, methodName='runTest'):
1886
# allow test parameterization after test construction and before test
1887
# execution. Variables that the parameterizer sets need to be
1888
# ones that are not set by setUp, or setUp will trash them.
1889
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1890
self.vfs_transport_factory = default_transport
1891
self.transport_server = None
1892
self.transport_readonly_server = None
1893
self.__vfs_server = None
1895
def get_transport(self, relpath=None):
1896
"""Return a writeable transport.
1898
This transport is for the test scratch space relative to
1901
:param relpath: a path relative to the base url.
1903
t = get_transport(self.get_url(relpath))
1904
self.assertFalse(t.is_readonly())
1907
def get_readonly_transport(self, relpath=None):
1908
"""Return a readonly transport for the test scratch space
1910
This can be used to test that operations which should only need
1911
readonly access in fact do not try to write.
1913
:param relpath: a path relative to the base url.
1915
t = get_transport(self.get_readonly_url(relpath))
1916
self.assertTrue(t.is_readonly())
1919
def create_transport_readonly_server(self):
1920
"""Create a transport server from class defined at init.
1922
This is mostly a hook for daughter classes.
1924
return self.transport_readonly_server()
1926
def get_readonly_server(self):
1927
"""Get the server instance for the readonly transport
1929
This is useful for some tests with specific servers to do diagnostics.
1931
if self.__readonly_server is None:
1932
if self.transport_readonly_server is None:
1933
# readonly decorator requested
1934
# bring up the server
1935
self.__readonly_server = ReadonlyServer()
1936
self.__readonly_server.setUp(self.get_vfs_only_server())
1938
self.__readonly_server = self.create_transport_readonly_server()
1939
self.__readonly_server.setUp(self.get_vfs_only_server())
1940
self.addCleanup(self.__readonly_server.tearDown)
1941
return self.__readonly_server
1943
def get_readonly_url(self, relpath=None):
1944
"""Get a URL for the readonly transport.
1946
This will either be backed by '.' or a decorator to the transport
1947
used by self.get_url()
1948
relpath provides for clients to get a path relative to the base url.
1949
These should only be downwards relative, not upwards.
1951
base = self.get_readonly_server().get_url()
1952
return self._adjust_url(base, relpath)
1954
def get_vfs_only_server(self):
1955
"""Get the vfs only read/write server instance.
1957
This is useful for some tests with specific servers that need
1960
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1961
is no means to override it.
1963
if self.__vfs_server is None:
1964
self.__vfs_server = MemoryServer()
1965
self.__vfs_server.setUp()
1966
self.addCleanup(self.__vfs_server.tearDown)
1967
return self.__vfs_server
1969
def get_server(self):
1970
"""Get the read/write server instance.
1972
This is useful for some tests with specific servers that need
1975
This is built from the self.transport_server factory. If that is None,
1976
then the self.get_vfs_server is returned.
1978
if self.__server is None:
1979
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1980
return self.get_vfs_only_server()
1982
# bring up a decorated means of access to the vfs only server.
1983
self.__server = self.transport_server()
1985
self.__server.setUp(self.get_vfs_only_server())
1986
except TypeError, e:
1987
# This should never happen; the try:Except here is to assist
1988
# developers having to update code rather than seeing an
1989
# uninformative TypeError.
1990
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1991
self.addCleanup(self.__server.tearDown)
1992
return self.__server
1994
def _adjust_url(self, base, relpath):
1995
"""Get a URL (or maybe a path) for the readwrite transport.
1997
This will either be backed by '.' or to an equivalent non-file based
1999
relpath provides for clients to get a path relative to the base url.
2000
These should only be downwards relative, not upwards.
2002
if relpath is not None and relpath != '.':
2003
if not base.endswith('/'):
2005
# XXX: Really base should be a url; we did after all call
2006
# get_url()! But sometimes it's just a path (from
2007
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2008
# to a non-escaped local path.
2009
if base.startswith('./') or base.startswith('/'):
2012
base += urlutils.escape(relpath)
2015
def get_url(self, relpath=None):
2016
"""Get a URL (or maybe a path) for the readwrite transport.
2018
This will either be backed by '.' or to an equivalent non-file based
2020
relpath provides for clients to get a path relative to the base url.
2021
These should only be downwards relative, not upwards.
2023
base = self.get_server().get_url()
2024
return self._adjust_url(base, relpath)
2026
def get_vfs_only_url(self, relpath=None):
2027
"""Get a URL (or maybe a path for the plain old vfs transport.
2029
This will never be a smart protocol. It always has all the
2030
capabilities of the local filesystem, but it might actually be a
2031
MemoryTransport or some other similar virtual filesystem.
2033
This is the backing transport (if any) of the server returned by
2034
get_url and get_readonly_url.
2036
:param relpath: provides for clients to get a path relative to the base
2037
url. These should only be downwards relative, not upwards.
2040
base = self.get_vfs_only_server().get_url()
2041
return self._adjust_url(base, relpath)
2043
def _create_safety_net(self):
2044
"""Make a fake bzr directory.
2046
This prevents any tests propagating up onto the TEST_ROOT directory's
2049
root = TestCaseWithMemoryTransport.TEST_ROOT
2050
bzrdir.BzrDir.create_standalone_workingtree(root)
2052
def _check_safety_net(self):
2053
"""Check that the safety .bzr directory have not been touched.
2055
_make_test_root have created a .bzr directory to prevent tests from
2056
propagating. This method ensures than a test did not leaked.
2058
root = TestCaseWithMemoryTransport.TEST_ROOT
2059
wt = workingtree.WorkingTree.open(root)
2060
last_rev = wt.last_revision()
2061
if last_rev != 'null:':
2062
# The current test have modified the /bzr directory, we need to
2063
# recreate a new one or all the followng tests will fail.
2064
# If you need to inspect its content uncomment the following line
2065
# import pdb; pdb.set_trace()
2066
_rmtree_temp_dir(root + '/.bzr')
2067
self._create_safety_net()
2068
raise AssertionError('%s/.bzr should not be modified' % root)
2070
def _make_test_root(self):
2071
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2072
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2073
TestCaseWithMemoryTransport.TEST_ROOT = root
2075
self._create_safety_net()
2077
# The same directory is used by all tests, and we're not
2078
# specifically told when all tests are finished. This will do.
2079
atexit.register(_rmtree_temp_dir, root)
2081
self.addCleanup(self._check_safety_net)
2083
def makeAndChdirToTestDir(self):
2084
"""Create a temporary directories for this one test.
2086
This must set self.test_home_dir and self.test_dir and chdir to
2089
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2091
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2092
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2093
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2095
def make_branch(self, relpath, format=None):
2096
"""Create a branch on the transport at relpath."""
2097
repo = self.make_repository(relpath, format=format)
2098
return repo.bzrdir.create_branch()
2100
def make_bzrdir(self, relpath, format=None):
2102
# might be a relative or absolute path
2103
maybe_a_url = self.get_url(relpath)
2104
segments = maybe_a_url.rsplit('/', 1)
2105
t = get_transport(maybe_a_url)
2106
if len(segments) > 1 and segments[-1] not in ('', '.'):
2110
if isinstance(format, basestring):
2111
format = bzrdir.format_registry.make_bzrdir(format)
2112
return format.initialize_on_transport(t)
2113
except errors.UninitializableFormat:
2114
raise TestSkipped("Format %s is not initializable." % format)
2116
def make_repository(self, relpath, shared=False, format=None):
2117
"""Create a repository on our default transport at relpath.
2119
Note that relpath must be a relative path, not a full url.
2121
# FIXME: If you create a remoterepository this returns the underlying
2122
# real format, which is incorrect. Actually we should make sure that
2123
# RemoteBzrDir returns a RemoteRepository.
2124
# maybe mbp 20070410
2125
made_control = self.make_bzrdir(relpath, format=format)
2126
return made_control.create_repository(shared=shared)
2128
def make_smart_server(self, path):
2129
smart_server = server.SmartTCPServer_for_testing()
2130
smart_server.setUp(self.get_server())
2131
remote_transport = get_transport(smart_server.get_url()).clone(path)
2132
self.addCleanup(smart_server.tearDown)
2133
return remote_transport
2135
def make_branch_and_memory_tree(self, relpath, format=None):
2136
"""Create a branch on the default transport and a MemoryTree for it."""
2137
b = self.make_branch(relpath, format=format)
2138
return memorytree.MemoryTree.create_on_branch(b)
2140
def make_branch_builder(self, relpath, format=None):
2141
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2144
def overrideEnvironmentForTesting(self):
2145
os.environ['HOME'] = self.test_home_dir
2146
os.environ['BZR_HOME'] = self.test_home_dir
2149
super(TestCaseWithMemoryTransport, self).setUp()
2150
self._make_test_root()
2151
_currentdir = os.getcwdu()
2152
def _leaveDirectory():
2153
os.chdir(_currentdir)
2154
self.addCleanup(_leaveDirectory)
2155
self.makeAndChdirToTestDir()
2156
self.overrideEnvironmentForTesting()
2157
self.__readonly_server = None
2158
self.__server = None
2159
self.reduceLockdirTimeout()
2161
def setup_smart_server_with_call_log(self):
2162
"""Sets up a smart server as the transport server with a call log."""
2163
self.transport_server = server.SmartTCPServer_for_testing
2164
self.hpss_calls = []
2166
# Skip the current stack down to the caller of
2167
# setup_smart_server_with_call_log
2168
prefix_length = len(traceback.extract_stack()) - 2
2169
def capture_hpss_call(params):
2170
self.hpss_calls.append(
2171
CapturedCall(params, prefix_length))
2172
client._SmartClient.hooks.install_named_hook(
2173
'call', capture_hpss_call, None)
2175
def reset_smart_call_log(self):
2176
self.hpss_calls = []
2179
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2180
"""Derived class that runs a test within a temporary directory.
2182
This is useful for tests that need to create a branch, etc.
2184
The directory is created in a slightly complex way: for each
2185
Python invocation, a new temporary top-level directory is created.
2186
All test cases create their own directory within that. If the
2187
tests complete successfully, the directory is removed.
2189
:ivar test_base_dir: The path of the top-level directory for this
2190
test, which contains a home directory and a work directory.
2192
:ivar test_home_dir: An initially empty directory under test_base_dir
2193
which is used as $HOME for this test.
2195
:ivar test_dir: A directory under test_base_dir used as the current
2196
directory when the test proper is run.
2199
OVERRIDE_PYTHON = 'python'
2201
def check_file_contents(self, filename, expect):
2202
self.log("check contents of file %s" % filename)
2203
contents = file(filename, 'r').read()
2204
if contents != expect:
2205
self.log("expected: %r" % expect)
2206
self.log("actually: %r" % contents)
2207
self.fail("contents of %s not as expected" % filename)
2209
def _getTestDirPrefix(self):
2210
# create a directory within the top level test directory
2211
if sys.platform == 'win32':
2212
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2213
# windows is likely to have path-length limits so use a short name
2214
name_prefix = name_prefix[-30:]
2216
name_prefix = re.sub('[/]', '_', self.id())
2219
def makeAndChdirToTestDir(self):
2220
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2222
For TestCaseInTempDir we create a temporary directory based on the test
2223
name and then create two subdirs - test and home under it.
2225
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2227
for i in range(100):
2228
if os.path.exists(name):
2229
name = name_prefix + '_' + str(i)
2233
# now create test and home directories within this dir
2234
self.test_base_dir = name
2235
self.test_home_dir = self.test_base_dir + '/home'
2236
os.mkdir(self.test_home_dir)
2237
self.test_dir = self.test_base_dir + '/work'
2238
os.mkdir(self.test_dir)
2239
os.chdir(self.test_dir)
2240
# put name of test inside
2241
f = file(self.test_base_dir + '/name', 'w')
2246
self.addCleanup(self.deleteTestDir)
2248
def deleteTestDir(self):
2249
os.chdir(self.TEST_ROOT)
2250
_rmtree_temp_dir(self.test_base_dir)
2252
def build_tree(self, shape, line_endings='binary', transport=None):
2253
"""Build a test tree according to a pattern.
2255
shape is a sequence of file specifications. If the final
2256
character is '/', a directory is created.
2258
This assumes that all the elements in the tree being built are new.
2260
This doesn't add anything to a branch.
2262
:type shape: list or tuple.
2263
:param line_endings: Either 'binary' or 'native'
2264
in binary mode, exact contents are written in native mode, the
2265
line endings match the default platform endings.
2266
:param transport: A transport to write to, for building trees on VFS's.
2267
If the transport is readonly or None, "." is opened automatically.
2270
if type(shape) not in (list, tuple):
2271
raise AssertionError("Parameter 'shape' should be "
2272
"a list or a tuple. Got %r instead" % (shape,))
2273
# It's OK to just create them using forward slashes on windows.
2274
if transport is None or transport.is_readonly():
2275
transport = get_transport(".")
2277
self.assertIsInstance(name, basestring)
2279
transport.mkdir(urlutils.escape(name[:-1]))
2281
if line_endings == 'binary':
2283
elif line_endings == 'native':
2286
raise errors.BzrError(
2287
'Invalid line ending request %r' % line_endings)
2288
content = "contents of %s%s" % (name.encode('utf-8'), end)
2289
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2291
def build_tree_contents(self, shape):
2292
build_tree_contents(shape)
2294
def assertInWorkingTree(self, path, root_path='.', tree=None):
2295
"""Assert whether path or paths are in the WorkingTree"""
2297
tree = workingtree.WorkingTree.open(root_path)
2298
if not isinstance(path, basestring):
2300
self.assertInWorkingTree(p, tree=tree)
2302
self.assertIsNot(tree.path2id(path), None,
2303
path+' not in working tree.')
2305
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2306
"""Assert whether path or paths are not in the WorkingTree"""
2308
tree = workingtree.WorkingTree.open(root_path)
2309
if not isinstance(path, basestring):
2311
self.assertNotInWorkingTree(p,tree=tree)
2313
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2316
class TestCaseWithTransport(TestCaseInTempDir):
2317
"""A test case that provides get_url and get_readonly_url facilities.
2319
These back onto two transport servers, one for readonly access and one for
2322
If no explicit class is provided for readonly access, a
2323
ReadonlyTransportDecorator is used instead which allows the use of non disk
2324
based read write transports.
2326
If an explicit class is provided for readonly access, that server and the
2327
readwrite one must both define get_url() as resolving to os.getcwd().
2330
def get_vfs_only_server(self):
2331
"""See TestCaseWithMemoryTransport.
2333
This is useful for some tests with specific servers that need
2336
if self.__vfs_server is None:
2337
self.__vfs_server = self.vfs_transport_factory()
2338
self.__vfs_server.setUp()
2339
self.addCleanup(self.__vfs_server.tearDown)
2340
return self.__vfs_server
2342
def make_branch_and_tree(self, relpath, format=None):
2343
"""Create a branch on the transport and a tree locally.
2345
If the transport is not a LocalTransport, the Tree can't be created on
2346
the transport. In that case if the vfs_transport_factory is
2347
LocalURLServer the working tree is created in the local
2348
directory backing the transport, and the returned tree's branch and
2349
repository will also be accessed locally. Otherwise a lightweight
2350
checkout is created and returned.
2352
:param format: The BzrDirFormat.
2353
:returns: the WorkingTree.
2355
# TODO: always use the local disk path for the working tree,
2356
# this obviously requires a format that supports branch references
2357
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2359
b = self.make_branch(relpath, format=format)
2361
return b.bzrdir.create_workingtree()
2362
except errors.NotLocalUrl:
2363
# We can only make working trees locally at the moment. If the
2364
# transport can't support them, then we keep the non-disk-backed
2365
# branch and create a local checkout.
2366
if self.vfs_transport_factory is LocalURLServer:
2367
# the branch is colocated on disk, we cannot create a checkout.
2368
# hopefully callers will expect this.
2369
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2370
wt = local_controldir.create_workingtree()
2371
if wt.branch._format != b._format:
2373
# Make sure that assigning to wt._branch fixes wt.branch,
2374
# in case the implementation details of workingtree objects
2376
self.assertIs(b, wt.branch)
2379
return b.create_checkout(relpath, lightweight=True)
2381
def assertIsDirectory(self, relpath, transport):
2382
"""Assert that relpath within transport is a directory.
2384
This may not be possible on all transports; in that case it propagates
2385
a TransportNotPossible.
2388
mode = transport.stat(relpath).st_mode
2389
except errors.NoSuchFile:
2390
self.fail("path %s is not a directory; no such file"
2392
if not stat.S_ISDIR(mode):
2393
self.fail("path %s is not a directory; has mode %#o"
2396
def assertTreesEqual(self, left, right):
2397
"""Check that left and right have the same content and properties."""
2398
# we use a tree delta to check for equality of the content, and we
2399
# manually check for equality of other things such as the parents list.
2400
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2401
differences = left.changes_from(right)
2402
self.assertFalse(differences.has_changed(),
2403
"Trees %r and %r are different: %r" % (left, right, differences))
2406
super(TestCaseWithTransport, self).setUp()
2407
self.__vfs_server = None
2410
class ChrootedTestCase(TestCaseWithTransport):
2411
"""A support class that provides readonly urls outside the local namespace.
2413
This is done by checking if self.transport_server is a MemoryServer. if it
2414
is then we are chrooted already, if it is not then an HttpServer is used
2417
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2418
be used without needed to redo it when a different
2419
subclass is in use ?
2423
super(ChrootedTestCase, self).setUp()
2424
if not self.vfs_transport_factory == MemoryServer:
2425
self.transport_readonly_server = HttpServer
2428
def condition_id_re(pattern):
2429
"""Create a condition filter which performs a re check on a test's id.
2431
:param pattern: A regular expression string.
2432
:return: A callable that returns True if the re matches.
2434
filter_re = re.compile(pattern)
2435
def condition(test):
2437
return filter_re.search(test_id)
2441
def condition_isinstance(klass_or_klass_list):
2442
"""Create a condition filter which returns isinstance(param, klass).
2444
:return: A callable which when called with one parameter obj return the
2445
result of isinstance(obj, klass_or_klass_list).
2448
return isinstance(obj, klass_or_klass_list)
2452
def condition_id_in_list(id_list):
2453
"""Create a condition filter which verify that test's id in a list.
2455
:param id_list: A TestIdList object.
2456
:return: A callable that returns True if the test's id appears in the list.
2458
def condition(test):
2459
return id_list.includes(test.id())
2463
def condition_id_startswith(starts):
2464
"""Create a condition filter verifying that test's id starts with a string.
2466
:param starts: A list of string.
2467
:return: A callable that returns True if the test's id starts with one of
2470
def condition(test):
2471
for start in starts:
2472
if test.id().startswith(start):
2478
def exclude_tests_by_condition(suite, condition):
2479
"""Create a test suite which excludes some tests from suite.
2481
:param suite: The suite to get tests from.
2482
:param condition: A callable whose result evaluates True when called with a
2483
test case which should be excluded from the result.
2484
:return: A suite which contains the tests found in suite that fail
2488
for test in iter_suite_tests(suite):
2489
if not condition(test):
2491
return TestUtil.TestSuite(result)
2494
def filter_suite_by_condition(suite, condition):
2495
"""Create a test suite by filtering another one.
2497
:param suite: The source suite.
2498
:param condition: A callable whose result evaluates True when called with a
2499
test case which should be included in the result.
2500
:return: A suite which contains the tests found in suite that pass
2504
for test in iter_suite_tests(suite):
2507
return TestUtil.TestSuite(result)
2510
def filter_suite_by_re(suite, pattern):
2511
"""Create a test suite by filtering another one.
2513
:param suite: the source suite
2514
:param pattern: pattern that names must match
2515
:returns: the newly created suite
2517
condition = condition_id_re(pattern)
2518
result_suite = filter_suite_by_condition(suite, condition)
2522
def filter_suite_by_id_list(suite, test_id_list):
2523
"""Create a test suite by filtering another one.
2525
:param suite: The source suite.
2526
:param test_id_list: A list of the test ids to keep as strings.
2527
:returns: the newly created suite
2529
condition = condition_id_in_list(test_id_list)
2530
result_suite = filter_suite_by_condition(suite, condition)
2534
def filter_suite_by_id_startswith(suite, start):
2535
"""Create a test suite by filtering another one.
2537
:param suite: The source suite.
2538
:param start: A list of string the test id must start with one of.
2539
:returns: the newly created suite
2541
condition = condition_id_startswith(start)
2542
result_suite = filter_suite_by_condition(suite, condition)
2546
def exclude_tests_by_re(suite, pattern):
2547
"""Create a test suite which excludes some tests from suite.
2549
:param suite: The suite to get tests from.
2550
:param pattern: A regular expression string. Test ids that match this
2551
pattern will be excluded from the result.
2552
:return: A TestSuite that contains all the tests from suite without the
2553
tests that matched pattern. The order of tests is the same as it was in
2556
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2559
def preserve_input(something):
2560
"""A helper for performing test suite transformation chains.
2562
:param something: Anything you want to preserve.
2568
def randomize_suite(suite):
2569
"""Return a new TestSuite with suite's tests in random order.
2571
The tests in the input suite are flattened into a single suite in order to
2572
accomplish this. Any nested TestSuites are removed to provide global
2575
tests = list(iter_suite_tests(suite))
2576
random.shuffle(tests)
2577
return TestUtil.TestSuite(tests)
2580
def split_suite_by_condition(suite, condition):
2581
"""Split a test suite into two by a condition.
2583
:param suite: The suite to split.
2584
:param condition: The condition to match on. Tests that match this
2585
condition are returned in the first test suite, ones that do not match
2586
are in the second suite.
2587
:return: A tuple of two test suites, where the first contains tests from
2588
suite matching the condition, and the second contains the remainder
2589
from suite. The order within each output suite is the same as it was in
2594
for test in iter_suite_tests(suite):
2596
matched.append(test)
2598
did_not_match.append(test)
2599
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2602
def split_suite_by_re(suite, pattern):
2603
"""Split a test suite into two by a regular expression.
2605
:param suite: The suite to split.
2606
:param pattern: A regular expression string. Test ids that match this
2607
pattern will be in the first test suite returned, and the others in the
2608
second test suite returned.
2609
:return: A tuple of two test suites, where the first contains tests from
2610
suite matching pattern, and the second contains the remainder from
2611
suite. The order within each output suite is the same as it was in
2614
return split_suite_by_condition(suite, condition_id_re(pattern))
2617
def run_suite(suite, name='test', verbose=False, pattern=".*",
2618
stop_on_failure=False,
2619
transport=None, lsprof_timed=None, bench_history=None,
2620
matching_tests_first=None,
2623
exclude_pattern=None,
2626
"""Run a test suite for bzr selftest.
2628
:param runner_class: The class of runner to use. Must support the
2629
constructor arguments passed by run_suite which are more than standard
2631
:return: A boolean indicating success.
2633
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2638
if runner_class is None:
2639
runner_class = TextTestRunner
2640
runner = runner_class(stream=sys.stdout,
2642
verbosity=verbosity,
2643
bench_history=bench_history,
2644
list_only=list_only,
2646
runner.stop_on_failure=stop_on_failure
2647
# Initialise the random number generator and display the seed used.
2648
# We convert the seed to a long to make it reuseable across invocations.
2649
random_order = False
2650
if random_seed is not None:
2652
if random_seed == "now":
2653
random_seed = long(time.time())
2655
# Convert the seed to a long if we can
2657
random_seed = long(random_seed)
2660
runner.stream.writeln("Randomizing test order using seed %s\n" %
2662
random.seed(random_seed)
2663
# Customise the list of tests if requested
2664
if exclude_pattern is not None:
2665
suite = exclude_tests_by_re(suite, exclude_pattern)
2667
order_changer = randomize_suite
2669
order_changer = preserve_input
2670
if pattern != '.*' or random_order:
2671
if matching_tests_first:
2672
suites = map(order_changer, split_suite_by_re(suite, pattern))
2673
suite = TestUtil.TestSuite(suites)
2675
suite = order_changer(filter_suite_by_re(suite, pattern))
2677
result = runner.run(suite)
2680
return result.wasStrictlySuccessful()
2682
return result.wasSuccessful()
2685
# Controlled by "bzr selftest -E=..." option
2686
selftest_debug_flags = set()
2689
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2691
test_suite_factory=None,
2694
matching_tests_first=None,
2697
exclude_pattern=None,
2704
"""Run the whole test suite under the enhanced runner"""
2705
# XXX: Very ugly way to do this...
2706
# Disable warning about old formats because we don't want it to disturb
2707
# any blackbox tests.
2708
from bzrlib import repository
2709
repository._deprecation_warning_done = True
2711
global default_transport
2712
if transport is None:
2713
transport = default_transport
2714
old_transport = default_transport
2715
default_transport = transport
2716
global selftest_debug_flags
2717
old_debug_flags = selftest_debug_flags
2718
if debug_flags is not None:
2719
selftest_debug_flags = set(debug_flags)
2721
if load_list is None:
2724
keep_only = load_test_id_list(load_list)
2725
if test_suite_factory is None:
2726
suite = test_suite(keep_only, starting_with)
2728
suite = test_suite_factory()
2729
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2730
stop_on_failure=stop_on_failure,
2731
transport=transport,
2732
lsprof_timed=lsprof_timed,
2733
bench_history=bench_history,
2734
matching_tests_first=matching_tests_first,
2735
list_only=list_only,
2736
random_seed=random_seed,
2737
exclude_pattern=exclude_pattern,
2739
runner_class=runner_class,
2742
default_transport = old_transport
2743
selftest_debug_flags = old_debug_flags
2746
def load_test_id_list(file_name):
2747
"""Load a test id list from a text file.
2749
The format is one test id by line. No special care is taken to impose
2750
strict rules, these test ids are used to filter the test suite so a test id
2751
that do not match an existing test will do no harm. This allows user to add
2752
comments, leave blank lines, etc.
2756
ftest = open(file_name, 'rt')
2758
if e.errno != errno.ENOENT:
2761
raise errors.NoSuchFile(file_name)
2763
for test_name in ftest.readlines():
2764
test_list.append(test_name.strip())
2769
def suite_matches_id_list(test_suite, id_list):
2770
"""Warns about tests not appearing or appearing more than once.
2772
:param test_suite: A TestSuite object.
2773
:param test_id_list: The list of test ids that should be found in
2776
:return: (absents, duplicates) absents is a list containing the test found
2777
in id_list but not in test_suite, duplicates is a list containing the
2778
test found multiple times in test_suite.
2780
When using a prefined test id list, it may occurs that some tests do not
2781
exist anymore or that some tests use the same id. This function warns the
2782
tester about potential problems in his workflow (test lists are volatile)
2783
or in the test suite itself (using the same id for several tests does not
2784
help to localize defects).
2786
# Build a dict counting id occurrences
2788
for test in iter_suite_tests(test_suite):
2790
tests[id] = tests.get(id, 0) + 1
2795
occurs = tests.get(id, 0)
2797
not_found.append(id)
2799
duplicates.append(id)
2801
return not_found, duplicates
2804
class TestIdList(object):
2805
"""Test id list to filter a test suite.
2807
Relying on the assumption that test ids are built as:
2808
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2809
notation, this class offers methods to :
2810
- avoid building a test suite for modules not refered to in the test list,
2811
- keep only the tests listed from the module test suite.
2814
def __init__(self, test_id_list):
2815
# When a test suite needs to be filtered against us we compare test ids
2816
# for equality, so a simple dict offers a quick and simple solution.
2817
self.tests = dict().fromkeys(test_id_list, True)
2819
# While unittest.TestCase have ids like:
2820
# <module>.<class>.<method>[(<param+)],
2821
# doctest.DocTestCase can have ids like:
2824
# <module>.<function>
2825
# <module>.<class>.<method>
2827
# Since we can't predict a test class from its name only, we settle on
2828
# a simple constraint: a test id always begins with its module name.
2831
for test_id in test_id_list:
2832
parts = test_id.split('.')
2833
mod_name = parts.pop(0)
2834
modules[mod_name] = True
2836
mod_name += '.' + part
2837
modules[mod_name] = True
2838
self.modules = modules
2840
def refers_to(self, module_name):
2841
"""Is there tests for the module or one of its sub modules."""
2842
return self.modules.has_key(module_name)
2844
def includes(self, test_id):
2845
return self.tests.has_key(test_id)
2848
class TestPrefixAliasRegistry(registry.Registry):
2849
"""A registry for test prefix aliases.
2851
This helps implement shorcuts for the --starting-with selftest
2852
option. Overriding existing prefixes is not allowed but not fatal (a
2853
warning will be emitted).
2856
def register(self, key, obj, help=None, info=None,
2857
override_existing=False):
2858
"""See Registry.register.
2860
Trying to override an existing alias causes a warning to be emitted,
2861
not a fatal execption.
2864
super(TestPrefixAliasRegistry, self).register(
2865
key, obj, help=help, info=info, override_existing=False)
2867
actual = self.get(key)
2868
note('Test prefix alias %s is already used for %s, ignoring %s'
2869
% (key, actual, obj))
2871
def resolve_alias(self, id_start):
2872
"""Replace the alias by the prefix in the given string.
2874
Using an unknown prefix is an error to help catching typos.
2876
parts = id_start.split('.')
2878
parts[0] = self.get(parts[0])
2880
raise errors.BzrCommandError(
2881
'%s is not a known test prefix alias' % parts[0])
2882
return '.'.join(parts)
2885
test_prefix_alias_registry = TestPrefixAliasRegistry()
2886
"""Registry of test prefix aliases."""
2889
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2890
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2891
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2893
# Obvious higest levels prefixes, feel free to add your own via a plugin
2894
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2895
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2896
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2897
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2898
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2901
def test_suite(keep_only=None, starting_with=None):
2902
"""Build and return TestSuite for the whole of bzrlib.
2904
:param keep_only: A list of test ids limiting the suite returned.
2906
:param starting_with: An id limiting the suite returned to the tests
2909
This function can be replaced if you need to change the default test
2910
suite on a global basis, but it is not encouraged.
2914
'bzrlib.tests.blackbox',
2915
'bzrlib.tests.branch_implementations',
2916
'bzrlib.tests.bzrdir_implementations',
2917
'bzrlib.tests.commands',
2918
'bzrlib.tests.interrepository_implementations',
2919
'bzrlib.tests.intertree_implementations',
2920
'bzrlib.tests.inventory_implementations',
2921
'bzrlib.tests.per_interbranch',
2922
'bzrlib.tests.per_lock',
2923
'bzrlib.tests.per_repository',
2924
'bzrlib.tests.per_repository_reference',
2925
'bzrlib.tests.test__dirstate_helpers',
2926
'bzrlib.tests.test__walkdirs_win32',
2927
'bzrlib.tests.test_ancestry',
2928
'bzrlib.tests.test_annotate',
2929
'bzrlib.tests.test_api',
2930
'bzrlib.tests.test_atomicfile',
2931
'bzrlib.tests.test_bad_files',
2932
'bzrlib.tests.test_bisect_multi',
2933
'bzrlib.tests.test_branch',
2934
'bzrlib.tests.test_branchbuilder',
2935
'bzrlib.tests.test_btree_index',
2936
'bzrlib.tests.test_bugtracker',
2937
'bzrlib.tests.test_bundle',
2938
'bzrlib.tests.test_bzrdir',
2939
'bzrlib.tests.test_cache_utf8',
2940
'bzrlib.tests.test_clean_tree',
2941
'bzrlib.tests.test_chunk_writer',
2942
'bzrlib.tests.test__chunks_to_lines',
2943
'bzrlib.tests.test_commands',
2944
'bzrlib.tests.test_commit',
2945
'bzrlib.tests.test_commit_merge',
2946
'bzrlib.tests.test_config',
2947
'bzrlib.tests.test_conflicts',
2948
'bzrlib.tests.test_counted_lock',
2949
'bzrlib.tests.test_decorators',
2950
'bzrlib.tests.test_delta',
2951
'bzrlib.tests.test_debug',
2952
'bzrlib.tests.test_deprecated_graph',
2953
'bzrlib.tests.test_diff',
2954
'bzrlib.tests.test_directory_service',
2955
'bzrlib.tests.test_dirstate',
2956
'bzrlib.tests.test_email_message',
2957
'bzrlib.tests.test_errors',
2958
'bzrlib.tests.test_export',
2959
'bzrlib.tests.test_extract',
2960
'bzrlib.tests.test_fetch',
2961
'bzrlib.tests.test_fifo_cache',
2962
'bzrlib.tests.test_ftp_transport',
2963
'bzrlib.tests.test_foreign',
2964
'bzrlib.tests.test_generate_docs',
2965
'bzrlib.tests.test_generate_ids',
2966
'bzrlib.tests.test_globbing',
2967
'bzrlib.tests.test_gpg',
2968
'bzrlib.tests.test_graph',
2969
'bzrlib.tests.test_hashcache',
2970
'bzrlib.tests.test_help',
2971
'bzrlib.tests.test_hooks',
2972
'bzrlib.tests.test_http',
2973
'bzrlib.tests.test_http_implementations',
2974
'bzrlib.tests.test_http_response',
2975
'bzrlib.tests.test_https_ca_bundle',
2976
'bzrlib.tests.test_identitymap',
2977
'bzrlib.tests.test_ignores',
2978
'bzrlib.tests.test_index',
2979
'bzrlib.tests.test_info',
2980
'bzrlib.tests.test_inv',
2981
'bzrlib.tests.test_knit',
2982
'bzrlib.tests.test_lazy_import',
2983
'bzrlib.tests.test_lazy_regex',
2984
'bzrlib.tests.test_lockable_files',
2985
'bzrlib.tests.test_lockdir',
2986
'bzrlib.tests.test_log',
2987
'bzrlib.tests.test_lru_cache',
2988
'bzrlib.tests.test_lsprof',
2989
'bzrlib.tests.test_mail_client',
2990
'bzrlib.tests.test_memorytree',
2991
'bzrlib.tests.test_merge',
2992
'bzrlib.tests.test_merge3',
2993
'bzrlib.tests.test_merge_core',
2994
'bzrlib.tests.test_merge_directive',
2995
'bzrlib.tests.test_missing',
2996
'bzrlib.tests.test_msgeditor',
2997
'bzrlib.tests.test_multiparent',
2998
'bzrlib.tests.test_mutabletree',
2999
'bzrlib.tests.test_nonascii',
3000
'bzrlib.tests.test_options',
3001
'bzrlib.tests.test_osutils',
3002
'bzrlib.tests.test_osutils_encodings',
3003
'bzrlib.tests.test_pack',
3004
'bzrlib.tests.test_pack_repository',
3005
'bzrlib.tests.test_patch',
3006
'bzrlib.tests.test_patches',
3007
'bzrlib.tests.test_permissions',
3008
'bzrlib.tests.test_plugins',
3009
'bzrlib.tests.test_progress',
3010
'bzrlib.tests.test_read_bundle',
3011
'bzrlib.tests.test_reconcile',
3012
'bzrlib.tests.test_reconfigure',
3013
'bzrlib.tests.test_registry',
3014
'bzrlib.tests.test_remote',
3015
'bzrlib.tests.test_repository',
3016
'bzrlib.tests.test_revert',
3017
'bzrlib.tests.test_revision',
3018
'bzrlib.tests.test_revisionspec',
3019
'bzrlib.tests.test_revisiontree',
3020
'bzrlib.tests.test_rio',
3021
'bzrlib.tests.test_rules',
3022
'bzrlib.tests.test_sampler',
3023
'bzrlib.tests.test_selftest',
3024
'bzrlib.tests.test_setup',
3025
'bzrlib.tests.test_sftp_transport',
3026
'bzrlib.tests.test_shelf',
3027
'bzrlib.tests.test_shelf_ui',
3028
'bzrlib.tests.test_smart',
3029
'bzrlib.tests.test_smart_add',
3030
'bzrlib.tests.test_smart_request',
3031
'bzrlib.tests.test_smart_transport',
3032
'bzrlib.tests.test_smtp_connection',
3033
'bzrlib.tests.test_source',
3034
'bzrlib.tests.test_ssh_transport',
3035
'bzrlib.tests.test_status',
3036
'bzrlib.tests.test_store',
3037
'bzrlib.tests.test_strace',
3038
'bzrlib.tests.test_subsume',
3039
'bzrlib.tests.test_switch',
3040
'bzrlib.tests.test_symbol_versioning',
3041
'bzrlib.tests.test_tag',
3042
'bzrlib.tests.test_testament',
3043
'bzrlib.tests.test_textfile',
3044
'bzrlib.tests.test_textmerge',
3045
'bzrlib.tests.test_timestamp',
3046
'bzrlib.tests.test_trace',
3047
'bzrlib.tests.test_transactions',
3048
'bzrlib.tests.test_transform',
3049
'bzrlib.tests.test_transport',
3050
'bzrlib.tests.test_transport_implementations',
3051
'bzrlib.tests.test_transport_log',
3052
'bzrlib.tests.test_tree',
3053
'bzrlib.tests.test_treebuilder',
3054
'bzrlib.tests.test_tsort',
3055
'bzrlib.tests.test_tuned_gzip',
3056
'bzrlib.tests.test_ui',
3057
'bzrlib.tests.test_uncommit',
3058
'bzrlib.tests.test_upgrade',
3059
'bzrlib.tests.test_upgrade_stacked',
3060
'bzrlib.tests.test_urlutils',
3061
'bzrlib.tests.test_version',
3062
'bzrlib.tests.test_version_info',
3063
'bzrlib.tests.test_versionedfile',
3064
'bzrlib.tests.test_weave',
3065
'bzrlib.tests.test_whitebox',
3066
'bzrlib.tests.test_win32utils',
3067
'bzrlib.tests.test_workingtree',
3068
'bzrlib.tests.test_workingtree_4',
3069
'bzrlib.tests.test_wsgi',
3070
'bzrlib.tests.test_xml',
3071
'bzrlib.tests.tree_implementations',
3072
'bzrlib.tests.workingtree_implementations',
3073
'bzrlib.util.tests.test_bencode',
3076
loader = TestUtil.TestLoader()
3079
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3080
for start in starting_with]
3081
# We take precedence over keep_only because *at loading time* using
3082
# both options means we will load less tests for the same final result.
3083
def interesting_module(name):
3084
for start in starting_with:
3086
# Either the module name starts with the specified string
3087
name.startswith(start)
3088
# or it may contain tests starting with the specified string
3089
or start.startswith(name)
3093
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3095
elif keep_only is not None:
3096
id_filter = TestIdList(keep_only)
3097
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3098
def interesting_module(name):
3099
return id_filter.refers_to(name)
3102
loader = TestUtil.TestLoader()
3103
def interesting_module(name):
3104
# No filtering, all modules are interesting
3107
suite = loader.suiteClass()
3109
# modules building their suite with loadTestsFromModuleNames
3110
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3112
modules_to_doctest = [
3114
'bzrlib.branchbuilder',
3117
'bzrlib.iterablefile',
3121
'bzrlib.symbol_versioning',
3124
'bzrlib.version_info_formats.format_custom',
3127
for mod in modules_to_doctest:
3128
if not interesting_module(mod):
3129
# No tests to keep here, move along
3132
# note that this really does mean "report only" -- doctest
3133
# still runs the rest of the examples
3134
doc_suite = doctest.DocTestSuite(mod,
3135
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3136
except ValueError, e:
3137
print '**failed to get doctest for: %s\n%s' % (mod, e)
3139
if len(doc_suite._tests) == 0:
3140
raise errors.BzrError("no doctests found in %s" % (mod,))
3141
suite.addTest(doc_suite)
3143
default_encoding = sys.getdefaultencoding()
3144
for name, plugin in bzrlib.plugin.plugins().items():
3145
if not interesting_module(plugin.module.__name__):
3147
plugin_suite = plugin.test_suite()
3148
# We used to catch ImportError here and turn it into just a warning,
3149
# but really if you don't have --no-plugins this should be a failure.
3150
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3151
if plugin_suite is None:
3152
plugin_suite = plugin.load_plugin_tests(loader)
3153
if plugin_suite is not None:
3154
suite.addTest(plugin_suite)
3155
if default_encoding != sys.getdefaultencoding():
3156
bzrlib.trace.warning(
3157
'Plugin "%s" tried to reset default encoding to: %s', name,
3158
sys.getdefaultencoding())
3160
sys.setdefaultencoding(default_encoding)
3163
suite = filter_suite_by_id_startswith(suite, starting_with)
3165
if keep_only is not None:
3166
# Now that the referred modules have loaded their tests, keep only the
3168
suite = filter_suite_by_id_list(suite, id_filter)
3169
# Do some sanity checks on the id_list filtering
3170
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3172
# The tester has used both keep_only and starting_with, so he is
3173
# already aware that some tests are excluded from the list, there
3174
# is no need to tell him which.
3177
# Some tests mentioned in the list are not in the test suite. The
3178
# list may be out of date, report to the tester.
3179
for id in not_found:
3180
bzrlib.trace.warning('"%s" not found in the test suite', id)
3181
for id in duplicates:
3182
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3187
def multiply_scenarios(scenarios_left, scenarios_right):
3188
"""Multiply two sets of scenarios.
3190
:returns: the cartesian product of the two sets of scenarios, that is
3191
a scenario for every possible combination of a left scenario and a
3195
('%s,%s' % (left_name, right_name),
3196
dict(left_dict.items() + right_dict.items()))
3197
for left_name, left_dict in scenarios_left
3198
for right_name, right_dict in scenarios_right]
3201
def multiply_tests(tests, scenarios, result):
3202
"""Multiply tests_list by scenarios into result.
3204
This is the core workhorse for test parameterisation.
3206
Typically the load_tests() method for a per-implementation test suite will
3207
call multiply_tests and return the result.
3209
:param tests: The tests to parameterise.
3210
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3211
scenario_param_dict).
3212
:param result: A TestSuite to add created tests to.
3214
This returns the passed in result TestSuite with the cross product of all
3215
the tests repeated once for each scenario. Each test is adapted by adding
3216
the scenario name at the end of its id(), and updating the test object's
3217
__dict__ with the scenario_param_dict.
3219
>>> r = multiply_tests(
3220
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3221
... [('one', dict(param=1)),
3222
... ('two', dict(param=2))],
3224
>>> tests = list(iter_suite_tests(r))
3228
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3234
for test in iter_suite_tests(tests):
3235
apply_scenarios(test, scenarios, result)
3239
def apply_scenarios(test, scenarios, result):
3240
"""Apply the scenarios in scenarios to test and add to result.
3242
:param test: The test to apply scenarios to.
3243
:param scenarios: An iterable of scenarios to apply to test.
3245
:seealso: apply_scenario
3247
for scenario in scenarios:
3248
result.addTest(apply_scenario(test, scenario))
3252
def apply_scenario(test, scenario):
3253
"""Copy test and apply scenario to it.
3255
:param test: A test to adapt.
3256
:param scenario: A tuple describing the scenarion.
3257
The first element of the tuple is the new test id.
3258
The second element is a dict containing attributes to set on the
3260
:return: The adapted test.
3262
new_id = "%s(%s)" % (test.id(), scenario[0])
3263
new_test = clone_test(test, new_id)
3264
for name, value in scenario[1].items():
3265
setattr(new_test, name, value)
3269
def clone_test(test, new_id):
3270
"""Clone a test giving it a new id.
3272
:param test: The test to clone.
3273
:param new_id: The id to assign to it.
3274
:return: The new test.
3276
from copy import deepcopy
3277
new_test = deepcopy(test)
3278
new_test.id = lambda: new_id
3282
def _rmtree_temp_dir(dirname):
3283
# If LANG=C we probably have created some bogus paths
3284
# which rmtree(unicode) will fail to delete
3285
# so make sure we are using rmtree(str) to delete everything
3286
# except on win32, where rmtree(str) will fail
3287
# since it doesn't have the property of byte-stream paths
3288
# (they are either ascii or mbcs)
3289
if sys.platform == 'win32':
3290
# make sure we are using the unicode win32 api
3291
dirname = unicode(dirname)
3293
dirname = dirname.encode(sys.getfilesystemencoding())
3295
osutils.rmtree(dirname)
3297
if sys.platform == 'win32' and e.errno == errno.EACCES:
3298
sys.stderr.write(('Permission denied: '
3299
'unable to remove testing dir '
3300
'%s\n' % os.path.basename(dirname)))
3305
class Feature(object):
3306
"""An operating system Feature."""
3309
self._available = None
3311
def available(self):
3312
"""Is the feature available?
3314
:return: True if the feature is available.
3316
if self._available is None:
3317
self._available = self._probe()
3318
return self._available
3321
"""Implement this method in concrete features.
3323
:return: True if the feature is available.
3325
raise NotImplementedError
3328
if getattr(self, 'feature_name', None):
3329
return self.feature_name()
3330
return self.__class__.__name__
3333
class _SymlinkFeature(Feature):
3336
return osutils.has_symlinks()
3338
def feature_name(self):
3341
SymlinkFeature = _SymlinkFeature()
3344
class _HardlinkFeature(Feature):
3347
return osutils.has_hardlinks()
3349
def feature_name(self):
3352
HardlinkFeature = _HardlinkFeature()
3355
class _OsFifoFeature(Feature):
3358
return getattr(os, 'mkfifo', None)
3360
def feature_name(self):
3361
return 'filesystem fifos'
3363
OsFifoFeature = _OsFifoFeature()
3366
class _UnicodeFilenameFeature(Feature):
3367
"""Does the filesystem support Unicode filenames?"""
3371
# Check for character combinations unlikely to be covered by any
3372
# single non-unicode encoding. We use the characters
3373
# - greek small letter alpha (U+03B1) and
3374
# - braille pattern dots-123456 (U+283F).
3375
os.stat(u'\u03b1\u283f')
3376
except UnicodeEncodeError:
3378
except (IOError, OSError):
3379
# The filesystem allows the Unicode filename but the file doesn't
3383
# The filesystem allows the Unicode filename and the file exists,
3387
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3390
def probe_unicode_in_user_encoding():
3391
"""Try to encode several unicode strings to use in unicode-aware tests.
3392
Return first successfull match.
3394
:return: (unicode value, encoded plain string value) or (None, None)
3396
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3397
for uni_val in possible_vals:
3399
str_val = uni_val.encode(osutils.get_user_encoding())
3400
except UnicodeEncodeError:
3401
# Try a different character
3404
return uni_val, str_val
3408
def probe_bad_non_ascii(encoding):
3409
"""Try to find [bad] character with code [128..255]
3410
that cannot be decoded to unicode in some encoding.
3411
Return None if all non-ascii characters is valid
3414
for i in xrange(128, 256):
3417
char.decode(encoding)
3418
except UnicodeDecodeError:
3423
class _FTPServerFeature(Feature):
3424
"""Some tests want an FTP Server, check if one is available.
3426
Right now, the only way this is available is if 'medusa' is installed.
3427
http://www.amk.ca/python/code/medusa.html
3432
import bzrlib.tests.ftp_server
3437
def feature_name(self):
3441
FTPServerFeature = _FTPServerFeature()
3444
class _HTTPSServerFeature(Feature):
3445
"""Some tests want an https Server, check if one is available.
3447
Right now, the only way this is available is under python2.6 which provides
3458
def feature_name(self):
3459
return 'HTTPSServer'
3462
HTTPSServerFeature = _HTTPSServerFeature()
3465
class _UnicodeFilename(Feature):
3466
"""Does the filesystem support Unicode filenames?"""
3471
except UnicodeEncodeError:
3473
except (IOError, OSError):
3474
# The filesystem allows the Unicode filename but the file doesn't
3478
# The filesystem allows the Unicode filename and the file exists,
3482
UnicodeFilename = _UnicodeFilename()
3485
class _UTF8Filesystem(Feature):
3486
"""Is the filesystem UTF-8?"""
3489
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3493
UTF8Filesystem = _UTF8Filesystem()
3496
class _CaseInsCasePresFilenameFeature(Feature):
3497
"""Is the file-system case insensitive, but case-preserving?"""
3500
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3502
# first check truly case-preserving for created files, then check
3503
# case insensitive when opening existing files.
3504
name = osutils.normpath(name)
3505
base, rel = osutils.split(name)
3506
found_rel = osutils.canonical_relpath(base, name)
3507
return (found_rel == rel
3508
and os.path.isfile(name.upper())
3509
and os.path.isfile(name.lower()))
3514
def feature_name(self):
3515
return "case-insensitive case-preserving filesystem"
3517
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3520
class _CaseInsensitiveFilesystemFeature(Feature):
3521
"""Check if underlying filesystem is case-insensitive but *not* case
3524
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3525
# more likely to be case preserving, so this case is rare.
3528
if CaseInsCasePresFilenameFeature.available():
3531
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3532
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3533
TestCaseWithMemoryTransport.TEST_ROOT = root
3535
root = TestCaseWithMemoryTransport.TEST_ROOT
3536
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3538
name_a = osutils.pathjoin(tdir, 'a')
3539
name_A = osutils.pathjoin(tdir, 'A')
3541
result = osutils.isdir(name_A)
3542
_rmtree_temp_dir(tdir)
3545
def feature_name(self):
3546
return 'case-insensitive filesystem'
3548
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
