1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
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, request, 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())
830
# this hook should always be installed
831
request._install_hook()
833
def _silenceUI(self):
834
"""Turn off UI for duration of test"""
835
# by default the UI is off; tests can turn it on if they want it.
836
saved = ui.ui_factory
838
ui.ui_factory = saved
839
ui.ui_factory = ui.SilentUIFactory()
840
self.addCleanup(_restore)
842
def _ndiff_strings(self, a, b):
843
"""Return ndiff between two strings containing lines.
845
A trailing newline is added if missing to make the strings
847
if b and b[-1] != '\n':
849
if a and a[-1] != '\n':
851
difflines = difflib.ndiff(a.splitlines(True),
853
linejunk=lambda x: False,
854
charjunk=lambda x: False)
855
return ''.join(difflines)
857
def assertEqual(self, a, b, message=''):
861
except UnicodeError, e:
862
# If we can't compare without getting a UnicodeError, then
863
# obviously they are different
864
mutter('UnicodeError: %s', e)
867
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
869
pformat(a), pformat(b)))
871
assertEquals = assertEqual
873
def assertEqualDiff(self, a, b, message=None):
874
"""Assert two texts are equal, if not raise an exception.
876
This is intended for use with multi-line strings where it can
877
be hard to find the differences by eye.
879
# TODO: perhaps override assertEquals to call this for strings?
883
message = "texts not equal:\n"
885
message = 'first string is missing a final newline.\n'
887
message = 'second string is missing a final newline.\n'
888
raise AssertionError(message +
889
self._ndiff_strings(a, b))
891
def assertEqualMode(self, mode, mode_test):
892
self.assertEqual(mode, mode_test,
893
'mode mismatch %o != %o' % (mode, mode_test))
895
def assertEqualStat(self, expected, actual):
896
"""assert that expected and actual are the same stat result.
898
:param expected: A stat result.
899
:param actual: A stat result.
900
:raises AssertionError: If the expected and actual stat values differ
903
self.assertEqual(expected.st_size, actual.st_size)
904
self.assertEqual(expected.st_mtime, actual.st_mtime)
905
self.assertEqual(expected.st_ctime, actual.st_ctime)
906
self.assertEqual(expected.st_dev, actual.st_dev)
907
self.assertEqual(expected.st_ino, actual.st_ino)
908
self.assertEqual(expected.st_mode, actual.st_mode)
910
def assertLength(self, length, obj_with_len):
911
"""Assert that obj_with_len is of length length."""
912
if len(obj_with_len) != length:
913
self.fail("Incorrect length: wanted %d, got %d for %r" % (
914
length, len(obj_with_len), obj_with_len))
916
def assertPositive(self, val):
917
"""Assert that val is greater than 0."""
918
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
920
def assertNegative(self, val):
921
"""Assert that val is less than 0."""
922
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
924
def assertStartsWith(self, s, prefix):
925
if not s.startswith(prefix):
926
raise AssertionError('string %r does not start with %r' % (s, prefix))
928
def assertEndsWith(self, s, suffix):
929
"""Asserts that s ends with suffix."""
930
if not s.endswith(suffix):
931
raise AssertionError('string %r does not end with %r' % (s, suffix))
933
def assertContainsRe(self, haystack, needle_re, flags=0):
934
"""Assert that a contains something matching a regular expression."""
935
if not re.search(needle_re, haystack, flags):
936
if '\n' in haystack or len(haystack) > 60:
937
# a long string, format it in a more readable way
938
raise AssertionError(
939
'pattern "%s" not found in\n"""\\\n%s"""\n'
940
% (needle_re, haystack))
942
raise AssertionError('pattern "%s" not found in "%s"'
943
% (needle_re, haystack))
945
def assertNotContainsRe(self, haystack, needle_re, flags=0):
946
"""Assert that a does not match a regular expression"""
947
if re.search(needle_re, haystack, flags):
948
raise AssertionError('pattern "%s" found in "%s"'
949
% (needle_re, haystack))
951
def assertSubset(self, sublist, superlist):
952
"""Assert that every entry in sublist is present in superlist."""
953
missing = set(sublist) - set(superlist)
955
raise AssertionError("value(s) %r not present in container %r" %
956
(missing, superlist))
958
def assertListRaises(self, excClass, func, *args, **kwargs):
959
"""Fail unless excClass is raised when the iterator from func is used.
961
Many functions can return generators this makes sure
962
to wrap them in a list() call to make sure the whole generator
963
is run, and that the proper exception is raised.
966
list(func(*args, **kwargs))
970
if getattr(excClass,'__name__', None) is not None:
971
excName = excClass.__name__
973
excName = str(excClass)
974
raise self.failureException, "%s not raised" % excName
976
def assertRaises(self, excClass, callableObj, *args, **kwargs):
977
"""Assert that a callable raises a particular exception.
979
:param excClass: As for the except statement, this may be either an
980
exception class, or a tuple of classes.
981
:param callableObj: A callable, will be passed ``*args`` and
984
Returns the exception so that you can examine it.
987
callableObj(*args, **kwargs)
991
if getattr(excClass,'__name__', None) is not None:
992
excName = excClass.__name__
995
excName = str(excClass)
996
raise self.failureException, "%s not raised" % excName
998
def assertIs(self, left, right, message=None):
999
if not (left is right):
1000
if message is not None:
1001
raise AssertionError(message)
1003
raise AssertionError("%r is not %r." % (left, right))
1005
def assertIsNot(self, left, right, message=None):
1007
if message is not None:
1008
raise AssertionError(message)
1010
raise AssertionError("%r is %r." % (left, right))
1012
def assertTransportMode(self, transport, path, mode):
1013
"""Fail if a path does not have mode mode.
1015
If modes are not supported on this transport, the assertion is ignored.
1017
if not transport._can_roundtrip_unix_modebits():
1019
path_stat = transport.stat(path)
1020
actual_mode = stat.S_IMODE(path_stat.st_mode)
1021
self.assertEqual(mode, actual_mode,
1022
'mode of %r incorrect (%s != %s)'
1023
% (path, oct(mode), oct(actual_mode)))
1025
def assertIsSameRealPath(self, path1, path2):
1026
"""Fail if path1 and path2 points to different files"""
1027
self.assertEqual(osutils.realpath(path1),
1028
osutils.realpath(path2),
1029
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1031
def assertIsInstance(self, obj, kls):
1032
"""Fail if obj is not an instance of kls"""
1033
if not isinstance(obj, kls):
1034
self.fail("%r is an instance of %s rather than %s" % (
1035
obj, obj.__class__, kls))
1037
def expectFailure(self, reason, assertion, *args, **kwargs):
1038
"""Invoke a test, expecting it to fail for the given reason.
1040
This is for assertions that ought to succeed, but currently fail.
1041
(The failure is *expected* but not *wanted*.) Please be very precise
1042
about the failure you're expecting. If a new bug is introduced,
1043
AssertionError should be raised, not KnownFailure.
1045
Frequently, expectFailure should be followed by an opposite assertion.
1048
Intended to be used with a callable that raises AssertionError as the
1049
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1051
Raises KnownFailure if the test fails. Raises AssertionError if the
1056
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1058
self.assertEqual(42, dynamic_val)
1060
This means that a dynamic_val of 54 will cause the test to raise
1061
a KnownFailure. Once math is fixed and the expectFailure is removed,
1062
only a dynamic_val of 42 will allow the test to pass. Anything other
1063
than 54 or 42 will cause an AssertionError.
1066
assertion(*args, **kwargs)
1067
except AssertionError:
1068
raise KnownFailure(reason)
1070
self.fail('Unexpected success. Should have failed: %s' % reason)
1072
def assertFileEqual(self, content, path):
1073
"""Fail if path does not contain 'content'."""
1074
self.failUnlessExists(path)
1075
f = file(path, 'rb')
1080
self.assertEqualDiff(content, s)
1082
def failUnlessExists(self, path):
1083
"""Fail unless path or paths, which may be abs or relative, exist."""
1084
if not isinstance(path, basestring):
1086
self.failUnlessExists(p)
1088
self.failUnless(osutils.lexists(path),path+" does not exist")
1090
def failIfExists(self, path):
1091
"""Fail if path or paths, which may be abs or relative, exist."""
1092
if not isinstance(path, basestring):
1094
self.failIfExists(p)
1096
self.failIf(osutils.lexists(path),path+" exists")
1098
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1099
"""A helper for callDeprecated and applyDeprecated.
1101
:param a_callable: A callable to call.
1102
:param args: The positional arguments for the callable
1103
:param kwargs: The keyword arguments for the callable
1104
:return: A tuple (warnings, result). result is the result of calling
1105
a_callable(``*args``, ``**kwargs``).
1108
def capture_warnings(msg, cls=None, stacklevel=None):
1109
# we've hooked into a deprecation specific callpath,
1110
# only deprecations should getting sent via it.
1111
self.assertEqual(cls, DeprecationWarning)
1112
local_warnings.append(msg)
1113
original_warning_method = symbol_versioning.warn
1114
symbol_versioning.set_warning_method(capture_warnings)
1116
result = a_callable(*args, **kwargs)
1118
symbol_versioning.set_warning_method(original_warning_method)
1119
return (local_warnings, result)
1121
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1122
"""Call a deprecated callable without warning the user.
1124
Note that this only captures warnings raised by symbol_versioning.warn,
1125
not other callers that go direct to the warning module.
1127
To test that a deprecated method raises an error, do something like
1130
self.assertRaises(errors.ReservedId,
1131
self.applyDeprecated,
1132
deprecated_in((1, 5, 0)),
1136
:param deprecation_format: The deprecation format that the callable
1137
should have been deprecated with. This is the same type as the
1138
parameter to deprecated_method/deprecated_function. If the
1139
callable is not deprecated with this format, an assertion error
1141
:param a_callable: A callable to call. This may be a bound method or
1142
a regular function. It will be called with ``*args`` and
1144
:param args: The positional arguments for the callable
1145
:param kwargs: The keyword arguments for the callable
1146
:return: The result of a_callable(``*args``, ``**kwargs``)
1148
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1150
expected_first_warning = symbol_versioning.deprecation_string(
1151
a_callable, deprecation_format)
1152
if len(call_warnings) == 0:
1153
self.fail("No deprecation warning generated by call to %s" %
1155
self.assertEqual(expected_first_warning, call_warnings[0])
1158
def callCatchWarnings(self, fn, *args, **kw):
1159
"""Call a callable that raises python warnings.
1161
The caller's responsible for examining the returned warnings.
1163
If the callable raises an exception, the exception is not
1164
caught and propagates up to the caller. In that case, the list
1165
of warnings is not available.
1167
:returns: ([warning_object, ...], fn_result)
1169
# XXX: This is not perfect, because it completely overrides the
1170
# warnings filters, and some code may depend on suppressing particular
1171
# warnings. It's the easiest way to insulate ourselves from -Werror,
1172
# though. -- Andrew, 20071062
1174
def _catcher(message, category, filename, lineno, file=None, line=None):
1175
# despite the name, 'message' is normally(?) a Warning subclass
1177
wlist.append(message)
1178
saved_showwarning = warnings.showwarning
1179
saved_filters = warnings.filters
1181
warnings.showwarning = _catcher
1182
warnings.filters = []
1183
result = fn(*args, **kw)
1185
warnings.showwarning = saved_showwarning
1186
warnings.filters = saved_filters
1187
return wlist, result
1189
def callDeprecated(self, expected, callable, *args, **kwargs):
1190
"""Assert that a callable is deprecated in a particular way.
1192
This is a very precise test for unusual requirements. The
1193
applyDeprecated helper function is probably more suited for most tests
1194
as it allows you to simply specify the deprecation format being used
1195
and will ensure that that is issued for the function being called.
1197
Note that this only captures warnings raised by symbol_versioning.warn,
1198
not other callers that go direct to the warning module. To catch
1199
general warnings, use callCatchWarnings.
1201
:param expected: a list of the deprecation warnings expected, in order
1202
:param callable: The callable to call
1203
:param args: The positional arguments for the callable
1204
:param kwargs: The keyword arguments for the callable
1206
call_warnings, result = self._capture_deprecation_warnings(callable,
1208
self.assertEqual(expected, call_warnings)
1211
def _startLogFile(self):
1212
"""Send bzr and test log messages to a temporary file.
1214
The file is removed as the test is torn down.
1216
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1217
self._log_file = os.fdopen(fileno, 'w+')
1218
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1219
self._log_file_name = name
1220
self.addCleanup(self._finishLogFile)
1222
def _finishLogFile(self):
1223
"""Finished with the log file.
1225
Close the file and delete it, unless setKeepLogfile was called.
1227
if self._log_file is None:
1229
bzrlib.trace.pop_log_file(self._log_memento)
1230
self._log_file.close()
1231
self._log_file = None
1232
if not self._keep_log_file:
1233
os.remove(self._log_file_name)
1234
self._log_file_name = None
1236
def setKeepLogfile(self):
1237
"""Make the logfile not be deleted when _finishLogFile is called."""
1238
self._keep_log_file = True
1240
def addCleanup(self, callable, *args, **kwargs):
1241
"""Arrange to run a callable when this case is torn down.
1243
Callables are run in the reverse of the order they are registered,
1244
ie last-in first-out.
1246
self._cleanups.append((callable, args, kwargs))
1248
def _cleanEnvironment(self):
1250
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1251
'HOME': os.getcwd(),
1252
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1253
# tests do check our impls match APPDATA
1254
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1258
'BZREMAIL': None, # may still be present in the environment
1260
'BZR_PROGRESS_BAR': None,
1262
'BZR_PLUGIN_PATH': None,
1264
'SSH_AUTH_SOCK': None,
1268
'https_proxy': None,
1269
'HTTPS_PROXY': None,
1274
# Nobody cares about these ones AFAIK. So far at
1275
# least. If you do (care), please update this comment
1279
'BZR_REMOTE_PATH': None,
1282
self.addCleanup(self._restoreEnvironment)
1283
for name, value in new_env.iteritems():
1284
self._captureVar(name, value)
1286
def _captureVar(self, name, newvalue):
1287
"""Set an environment variable, and reset it when finished."""
1288
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1290
def _restore_debug_flags(self):
1291
debug.debug_flags.clear()
1292
debug.debug_flags.update(self._preserved_debug_flags)
1294
def _restoreEnvironment(self):
1295
for name, value in self.__old_env.iteritems():
1296
osutils.set_or_unset_env(name, value)
1298
def _restoreHooks(self):
1299
for klass, (name, hooks) in self._preserved_hooks.items():
1300
setattr(klass, name, hooks)
1302
def knownFailure(self, reason):
1303
"""This test has failed for some known reason."""
1304
raise KnownFailure(reason)
1306
def _do_skip(self, result, reason):
1307
addSkip = getattr(result, 'addSkip', None)
1308
if not callable(addSkip):
1309
result.addError(self, self.exc_info())
1311
addSkip(self, reason)
1313
def run(self, result=None):
1314
if result is None: result = self.defaultTestResult()
1315
for feature in getattr(self, '_test_needs_features', []):
1316
if not feature.available():
1317
result.startTest(self)
1318
if getattr(result, 'addNotSupported', None):
1319
result.addNotSupported(self, feature)
1321
result.addSuccess(self)
1322
result.stopTest(self)
1326
result.startTest(self)
1327
absent_attr = object()
1329
method_name = getattr(self, '_testMethodName', absent_attr)
1330
if method_name is absent_attr:
1332
method_name = getattr(self, '_TestCase__testMethodName')
1333
testMethod = getattr(self, method_name)
1337
if not self._bzr_test_setUp_run:
1339
"test setUp did not invoke "
1340
"bzrlib.tests.TestCase's setUp")
1341
except KeyboardInterrupt:
1343
except TestSkipped, e:
1344
self._do_skip(result, e.args[0])
1348
result.addError(self, self.exc_info())
1355
except self.failureException:
1356
result.addFailure(self, self.exc_info())
1357
except TestSkipped, e:
1359
reason = "No reason given."
1362
self._do_skip(result, reason)
1363
except KeyboardInterrupt:
1366
result.addError(self, self.exc_info())
1370
if not self._bzr_test_tearDown_run:
1372
"test tearDown did not invoke "
1373
"bzrlib.tests.TestCase's tearDown")
1374
except KeyboardInterrupt:
1377
result.addError(self, self.exc_info())
1379
if ok: result.addSuccess(self)
1381
result.stopTest(self)
1383
except TestNotApplicable:
1384
# Not moved from the result [yet].
1386
except KeyboardInterrupt:
1390
absent_attr = object()
1391
for attr_name in self.attrs_to_keep:
1392
attr = getattr(self, attr_name, absent_attr)
1393
if attr is not absent_attr:
1394
saved_attrs[attr_name] = attr
1395
self.__dict__ = saved_attrs
1398
self._bzr_test_tearDown_run = True
1400
self._log_contents = ''
1401
unittest.TestCase.tearDown(self)
1403
def time(self, callable, *args, **kwargs):
1404
"""Run callable and accrue the time it takes to the benchmark time.
1406
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1407
this will cause lsprofile statistics to be gathered and stored in
1410
if self._benchtime is None:
1414
if not self._gather_lsprof_in_benchmarks:
1415
return callable(*args, **kwargs)
1417
# record this benchmark
1418
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1420
self._benchcalls.append(((callable, args, kwargs), stats))
1423
self._benchtime += time.time() - start
1425
def _runCleanups(self):
1426
"""Run registered cleanup functions.
1428
This should only be called from TestCase.tearDown.
1430
# TODO: Perhaps this should keep running cleanups even if
1431
# one of them fails?
1433
# Actually pop the cleanups from the list so tearDown running
1434
# twice is safe (this happens for skipped tests).
1435
while self._cleanups:
1436
cleanup, args, kwargs = self._cleanups.pop()
1437
cleanup(*args, **kwargs)
1439
def log(self, *args):
1442
def _get_log(self, keep_log_file=False):
1443
"""Get the log from bzrlib.trace calls from this test.
1445
:param keep_log_file: When True, if the log is still a file on disk
1446
leave it as a file on disk. When False, if the log is still a file
1447
on disk, the log file is deleted and the log preserved as
1449
:return: A string containing the log.
1451
# flush the log file, to get all content
1453
if bzrlib.trace._trace_file:
1454
bzrlib.trace._trace_file.flush()
1455
if self._log_contents:
1456
# XXX: this can hardly contain the content flushed above --vila
1458
return self._log_contents
1459
if self._log_file_name is not None:
1460
logfile = open(self._log_file_name)
1462
log_contents = logfile.read()
1465
if not keep_log_file:
1466
self._log_contents = log_contents
1468
os.remove(self._log_file_name)
1470
if sys.platform == 'win32' and e.errno == errno.EACCES:
1471
sys.stderr.write(('Unable to delete log file '
1472
' %r\n' % self._log_file_name))
1477
return "DELETED log file to reduce memory footprint"
1479
def requireFeature(self, feature):
1480
"""This test requires a specific feature is available.
1482
:raises UnavailableFeature: When feature is not available.
1484
if not feature.available():
1485
raise UnavailableFeature(feature)
1487
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1489
"""Run bazaar command line, splitting up a string command line."""
1490
if isinstance(args, basestring):
1491
# shlex don't understand unicode strings,
1492
# so args should be plain string (bialix 20070906)
1493
args = list(shlex.split(str(args)))
1494
return self._run_bzr_core(args, retcode=retcode,
1495
encoding=encoding, stdin=stdin, working_dir=working_dir,
1498
def _run_bzr_core(self, args, retcode, encoding, stdin,
1500
if encoding is None:
1501
encoding = osutils.get_user_encoding()
1502
stdout = StringIOWrapper()
1503
stderr = StringIOWrapper()
1504
stdout.encoding = encoding
1505
stderr.encoding = encoding
1507
self.log('run bzr: %r', args)
1508
# FIXME: don't call into logging here
1509
handler = logging.StreamHandler(stderr)
1510
handler.setLevel(logging.INFO)
1511
logger = logging.getLogger('')
1512
logger.addHandler(handler)
1513
old_ui_factory = ui.ui_factory
1514
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1517
if working_dir is not None:
1518
cwd = osutils.getcwd()
1519
os.chdir(working_dir)
1522
result = self.apply_redirected(ui.ui_factory.stdin,
1524
bzrlib.commands.run_bzr_catch_user_errors,
1527
logger.removeHandler(handler)
1528
ui.ui_factory = old_ui_factory
1532
out = stdout.getvalue()
1533
err = stderr.getvalue()
1535
self.log('output:\n%r', out)
1537
self.log('errors:\n%r', err)
1538
if retcode is not None:
1539
self.assertEquals(retcode, result,
1540
message='Unexpected return code')
1543
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1544
working_dir=None, error_regexes=[], output_encoding=None):
1545
"""Invoke bzr, as if it were run from the command line.
1547
The argument list should not include the bzr program name - the
1548
first argument is normally the bzr command. Arguments may be
1549
passed in three ways:
1551
1- A list of strings, eg ["commit", "a"]. This is recommended
1552
when the command contains whitespace or metacharacters, or
1553
is built up at run time.
1555
2- A single string, eg "add a". This is the most convenient
1556
for hardcoded commands.
1558
This runs bzr through the interface that catches and reports
1559
errors, and with logging set to something approximating the
1560
default, so that error reporting can be checked.
1562
This should be the main method for tests that want to exercise the
1563
overall behavior of the bzr application (rather than a unit test
1564
or a functional test of the library.)
1566
This sends the stdout/stderr results into the test's log,
1567
where it may be useful for debugging. See also run_captured.
1569
:keyword stdin: A string to be used as stdin for the command.
1570
:keyword retcode: The status code the command should return;
1572
:keyword working_dir: The directory to run the command in
1573
:keyword error_regexes: A list of expected error messages. If
1574
specified they must be seen in the error output of the command.
1576
out, err = self._run_bzr_autosplit(
1581
working_dir=working_dir,
1583
for regex in error_regexes:
1584
self.assertContainsRe(err, regex)
1587
def run_bzr_error(self, error_regexes, *args, **kwargs):
1588
"""Run bzr, and check that stderr contains the supplied regexes
1590
:param error_regexes: Sequence of regular expressions which
1591
must each be found in the error output. The relative ordering
1593
:param args: command-line arguments for bzr
1594
:param kwargs: Keyword arguments which are interpreted by run_bzr
1595
This function changes the default value of retcode to be 3,
1596
since in most cases this is run when you expect bzr to fail.
1598
:return: (out, err) The actual output of running the command (in case
1599
you want to do more inspection)
1603
# Make sure that commit is failing because there is nothing to do
1604
self.run_bzr_error(['no changes to commit'],
1605
['commit', '-m', 'my commit comment'])
1606
# Make sure --strict is handling an unknown file, rather than
1607
# giving us the 'nothing to do' error
1608
self.build_tree(['unknown'])
1609
self.run_bzr_error(['Commit refused because there are unknown files'],
1610
['commit', --strict', '-m', 'my commit comment'])
1612
kwargs.setdefault('retcode', 3)
1613
kwargs['error_regexes'] = error_regexes
1614
out, err = self.run_bzr(*args, **kwargs)
1617
def run_bzr_subprocess(self, *args, **kwargs):
1618
"""Run bzr in a subprocess for testing.
1620
This starts a new Python interpreter and runs bzr in there.
1621
This should only be used for tests that have a justifiable need for
1622
this isolation: e.g. they are testing startup time, or signal
1623
handling, or early startup code, etc. Subprocess code can't be
1624
profiled or debugged so easily.
1626
:keyword retcode: The status code that is expected. Defaults to 0. If
1627
None is supplied, the status code is not checked.
1628
:keyword env_changes: A dictionary which lists changes to environment
1629
variables. A value of None will unset the env variable.
1630
The values must be strings. The change will only occur in the
1631
child, so you don't need to fix the environment after running.
1632
:keyword universal_newlines: Convert CRLF => LF
1633
:keyword allow_plugins: By default the subprocess is run with
1634
--no-plugins to ensure test reproducibility. Also, it is possible
1635
for system-wide plugins to create unexpected output on stderr,
1636
which can cause unnecessary test failures.
1638
env_changes = kwargs.get('env_changes', {})
1639
working_dir = kwargs.get('working_dir', None)
1640
allow_plugins = kwargs.get('allow_plugins', False)
1642
if isinstance(args[0], list):
1644
elif isinstance(args[0], basestring):
1645
args = list(shlex.split(args[0]))
1647
raise ValueError("passing varargs to run_bzr_subprocess")
1648
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1649
working_dir=working_dir,
1650
allow_plugins=allow_plugins)
1651
# We distinguish between retcode=None and retcode not passed.
1652
supplied_retcode = kwargs.get('retcode', 0)
1653
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1654
universal_newlines=kwargs.get('universal_newlines', False),
1657
def start_bzr_subprocess(self, process_args, env_changes=None,
1658
skip_if_plan_to_signal=False,
1660
allow_plugins=False):
1661
"""Start bzr in a subprocess for testing.
1663
This starts a new Python interpreter and runs bzr in there.
1664
This should only be used for tests that have a justifiable need for
1665
this isolation: e.g. they are testing startup time, or signal
1666
handling, or early startup code, etc. Subprocess code can't be
1667
profiled or debugged so easily.
1669
:param process_args: a list of arguments to pass to the bzr executable,
1670
for example ``['--version']``.
1671
:param env_changes: A dictionary which lists changes to environment
1672
variables. A value of None will unset the env variable.
1673
The values must be strings. The change will only occur in the
1674
child, so you don't need to fix the environment after running.
1675
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1677
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1679
:returns: Popen object for the started process.
1681
if skip_if_plan_to_signal:
1682
if not getattr(os, 'kill', None):
1683
raise TestSkipped("os.kill not available.")
1685
if env_changes is None:
1689
def cleanup_environment():
1690
for env_var, value in env_changes.iteritems():
1691
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1693
def restore_environment():
1694
for env_var, value in old_env.iteritems():
1695
osutils.set_or_unset_env(env_var, value)
1697
bzr_path = self.get_bzr_path()
1700
if working_dir is not None:
1701
cwd = osutils.getcwd()
1702
os.chdir(working_dir)
1705
# win32 subprocess doesn't support preexec_fn
1706
# so we will avoid using it on all platforms, just to
1707
# make sure the code path is used, and we don't break on win32
1708
cleanup_environment()
1709
command = [sys.executable]
1710
# frozen executables don't need the path to bzr
1711
if getattr(sys, "frozen", None) is None:
1712
command.append(bzr_path)
1713
if not allow_plugins:
1714
command.append('--no-plugins')
1715
command.extend(process_args)
1716
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1718
restore_environment()
1724
def _popen(self, *args, **kwargs):
1725
"""Place a call to Popen.
1727
Allows tests to override this method to intercept the calls made to
1728
Popen for introspection.
1730
return Popen(*args, **kwargs)
1732
def get_bzr_path(self):
1733
"""Return the path of the 'bzr' executable for this test suite."""
1734
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1735
if not os.path.isfile(bzr_path):
1736
# We are probably installed. Assume sys.argv is the right file
1737
bzr_path = sys.argv[0]
1740
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1741
universal_newlines=False, process_args=None):
1742
"""Finish the execution of process.
1744
:param process: the Popen object returned from start_bzr_subprocess.
1745
:param retcode: The status code that is expected. Defaults to 0. If
1746
None is supplied, the status code is not checked.
1747
:param send_signal: an optional signal to send to the process.
1748
:param universal_newlines: Convert CRLF => LF
1749
:returns: (stdout, stderr)
1751
if send_signal is not None:
1752
os.kill(process.pid, send_signal)
1753
out, err = process.communicate()
1755
if universal_newlines:
1756
out = out.replace('\r\n', '\n')
1757
err = err.replace('\r\n', '\n')
1759
if retcode is not None and retcode != process.returncode:
1760
if process_args is None:
1761
process_args = "(unknown args)"
1762
mutter('Output of bzr %s:\n%s', process_args, out)
1763
mutter('Error for bzr %s:\n%s', process_args, err)
1764
self.fail('Command bzr %s failed with retcode %s != %s'
1765
% (process_args, retcode, process.returncode))
1768
def check_inventory_shape(self, inv, shape):
1769
"""Compare an inventory to a list of expected names.
1771
Fail if they are not precisely equal.
1774
shape = list(shape) # copy
1775
for path, ie in inv.entries():
1776
name = path.replace('\\', '/')
1777
if ie.kind == 'directory':
1784
self.fail("expected paths not found in inventory: %r" % shape)
1786
self.fail("unexpected paths found in inventory: %r" % extras)
1788
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1789
a_callable=None, *args, **kwargs):
1790
"""Call callable with redirected std io pipes.
1792
Returns the return code."""
1793
if not callable(a_callable):
1794
raise ValueError("a_callable must be callable.")
1796
stdin = StringIO("")
1798
if getattr(self, "_log_file", None) is not None:
1799
stdout = self._log_file
1803
if getattr(self, "_log_file", None is not None):
1804
stderr = self._log_file
1807
real_stdin = sys.stdin
1808
real_stdout = sys.stdout
1809
real_stderr = sys.stderr
1814
return a_callable(*args, **kwargs)
1816
sys.stdout = real_stdout
1817
sys.stderr = real_stderr
1818
sys.stdin = real_stdin
1820
def reduceLockdirTimeout(self):
1821
"""Reduce the default lock timeout for the duration of the test, so that
1822
if LockContention occurs during a test, it does so quickly.
1824
Tests that expect to provoke LockContention errors should call this.
1826
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1828
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1829
self.addCleanup(resetTimeout)
1830
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1832
def make_utf8_encoded_stringio(self, encoding_type=None):
1833
"""Return a StringIOWrapper instance, that will encode Unicode
1836
if encoding_type is None:
1837
encoding_type = 'strict'
1839
output_encoding = 'utf-8'
1840
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1841
sio.encoding = output_encoding
1845
class CapturedCall(object):
1846
"""A helper for capturing smart server calls for easy debug analysis."""
1848
def __init__(self, params, prefix_length):
1849
"""Capture the call with params and skip prefix_length stack frames."""
1852
# The last 5 frames are the __init__, the hook frame, and 3 smart
1853
# client frames. Beyond this we could get more clever, but this is good
1855
stack = traceback.extract_stack()[prefix_length:-5]
1856
self.stack = ''.join(traceback.format_list(stack))
1859
return self.call.method
1862
return self.call.method
1868
class TestCaseWithMemoryTransport(TestCase):
1869
"""Common test class for tests that do not need disk resources.
1871
Tests that need disk resources should derive from TestCaseWithTransport.
1873
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1875
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1876
a directory which does not exist. This serves to help ensure test isolation
1877
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1878
must exist. However, TestCaseWithMemoryTransport does not offer local
1879
file defaults for the transport in tests, nor does it obey the command line
1880
override, so tests that accidentally write to the common directory should
1883
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1884
a .bzr directory that stops us ascending higher into the filesystem.
1890
def __init__(self, methodName='runTest'):
1891
# allow test parameterization after test construction and before test
1892
# execution. Variables that the parameterizer sets need to be
1893
# ones that are not set by setUp, or setUp will trash them.
1894
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1895
self.vfs_transport_factory = default_transport
1896
self.transport_server = None
1897
self.transport_readonly_server = None
1898
self.__vfs_server = None
1900
def get_transport(self, relpath=None):
1901
"""Return a writeable transport.
1903
This transport is for the test scratch space relative to
1906
:param relpath: a path relative to the base url.
1908
t = get_transport(self.get_url(relpath))
1909
self.assertFalse(t.is_readonly())
1912
def get_readonly_transport(self, relpath=None):
1913
"""Return a readonly transport for the test scratch space
1915
This can be used to test that operations which should only need
1916
readonly access in fact do not try to write.
1918
:param relpath: a path relative to the base url.
1920
t = get_transport(self.get_readonly_url(relpath))
1921
self.assertTrue(t.is_readonly())
1924
def create_transport_readonly_server(self):
1925
"""Create a transport server from class defined at init.
1927
This is mostly a hook for daughter classes.
1929
return self.transport_readonly_server()
1931
def get_readonly_server(self):
1932
"""Get the server instance for the readonly transport
1934
This is useful for some tests with specific servers to do diagnostics.
1936
if self.__readonly_server is None:
1937
if self.transport_readonly_server is None:
1938
# readonly decorator requested
1939
# bring up the server
1940
self.__readonly_server = ReadonlyServer()
1941
self.__readonly_server.setUp(self.get_vfs_only_server())
1943
self.__readonly_server = self.create_transport_readonly_server()
1944
self.__readonly_server.setUp(self.get_vfs_only_server())
1945
self.addCleanup(self.__readonly_server.tearDown)
1946
return self.__readonly_server
1948
def get_readonly_url(self, relpath=None):
1949
"""Get a URL for the readonly transport.
1951
This will either be backed by '.' or a decorator to the transport
1952
used by self.get_url()
1953
relpath provides for clients to get a path relative to the base url.
1954
These should only be downwards relative, not upwards.
1956
base = self.get_readonly_server().get_url()
1957
return self._adjust_url(base, relpath)
1959
def get_vfs_only_server(self):
1960
"""Get the vfs only read/write server instance.
1962
This is useful for some tests with specific servers that need
1965
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1966
is no means to override it.
1968
if self.__vfs_server is None:
1969
self.__vfs_server = MemoryServer()
1970
self.__vfs_server.setUp()
1971
self.addCleanup(self.__vfs_server.tearDown)
1972
return self.__vfs_server
1974
def get_server(self):
1975
"""Get the read/write server instance.
1977
This is useful for some tests with specific servers that need
1980
This is built from the self.transport_server factory. If that is None,
1981
then the self.get_vfs_server is returned.
1983
if self.__server is None:
1984
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1985
return self.get_vfs_only_server()
1987
# bring up a decorated means of access to the vfs only server.
1988
self.__server = self.transport_server()
1990
self.__server.setUp(self.get_vfs_only_server())
1991
except TypeError, e:
1992
# This should never happen; the try:Except here is to assist
1993
# developers having to update code rather than seeing an
1994
# uninformative TypeError.
1995
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1996
self.addCleanup(self.__server.tearDown)
1997
return self.__server
1999
def _adjust_url(self, base, relpath):
2000
"""Get a URL (or maybe a path) for the readwrite transport.
2002
This will either be backed by '.' or to an equivalent non-file based
2004
relpath provides for clients to get a path relative to the base url.
2005
These should only be downwards relative, not upwards.
2007
if relpath is not None and relpath != '.':
2008
if not base.endswith('/'):
2010
# XXX: Really base should be a url; we did after all call
2011
# get_url()! But sometimes it's just a path (from
2012
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2013
# to a non-escaped local path.
2014
if base.startswith('./') or base.startswith('/'):
2017
base += urlutils.escape(relpath)
2020
def get_url(self, relpath=None):
2021
"""Get a URL (or maybe a path) for the readwrite transport.
2023
This will either be backed by '.' or to an equivalent non-file based
2025
relpath provides for clients to get a path relative to the base url.
2026
These should only be downwards relative, not upwards.
2028
base = self.get_server().get_url()
2029
return self._adjust_url(base, relpath)
2031
def get_vfs_only_url(self, relpath=None):
2032
"""Get a URL (or maybe a path for the plain old vfs transport.
2034
This will never be a smart protocol. It always has all the
2035
capabilities of the local filesystem, but it might actually be a
2036
MemoryTransport or some other similar virtual filesystem.
2038
This is the backing transport (if any) of the server returned by
2039
get_url and get_readonly_url.
2041
:param relpath: provides for clients to get a path relative to the base
2042
url. These should only be downwards relative, not upwards.
2045
base = self.get_vfs_only_server().get_url()
2046
return self._adjust_url(base, relpath)
2048
def _create_safety_net(self):
2049
"""Make a fake bzr directory.
2051
This prevents any tests propagating up onto the TEST_ROOT directory's
2054
root = TestCaseWithMemoryTransport.TEST_ROOT
2055
bzrdir.BzrDir.create_standalone_workingtree(root)
2057
def _check_safety_net(self):
2058
"""Check that the safety .bzr directory have not been touched.
2060
_make_test_root have created a .bzr directory to prevent tests from
2061
propagating. This method ensures than a test did not leaked.
2063
root = TestCaseWithMemoryTransport.TEST_ROOT
2064
wt = workingtree.WorkingTree.open(root)
2065
last_rev = wt.last_revision()
2066
if last_rev != 'null:':
2067
# The current test have modified the /bzr directory, we need to
2068
# recreate a new one or all the followng tests will fail.
2069
# If you need to inspect its content uncomment the following line
2070
# import pdb; pdb.set_trace()
2071
_rmtree_temp_dir(root + '/.bzr')
2072
self._create_safety_net()
2073
raise AssertionError('%s/.bzr should not be modified' % root)
2075
def _make_test_root(self):
2076
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2077
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2078
TestCaseWithMemoryTransport.TEST_ROOT = root
2080
self._create_safety_net()
2082
# The same directory is used by all tests, and we're not
2083
# specifically told when all tests are finished. This will do.
2084
atexit.register(_rmtree_temp_dir, root)
2086
self.addCleanup(self._check_safety_net)
2088
def makeAndChdirToTestDir(self):
2089
"""Create a temporary directories for this one test.
2091
This must set self.test_home_dir and self.test_dir and chdir to
2094
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2096
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2097
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2098
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2100
def make_branch(self, relpath, format=None):
2101
"""Create a branch on the transport at relpath."""
2102
repo = self.make_repository(relpath, format=format)
2103
return repo.bzrdir.create_branch()
2105
def make_bzrdir(self, relpath, format=None):
2107
# might be a relative or absolute path
2108
maybe_a_url = self.get_url(relpath)
2109
segments = maybe_a_url.rsplit('/', 1)
2110
t = get_transport(maybe_a_url)
2111
if len(segments) > 1 and segments[-1] not in ('', '.'):
2115
if isinstance(format, basestring):
2116
format = bzrdir.format_registry.make_bzrdir(format)
2117
return format.initialize_on_transport(t)
2118
except errors.UninitializableFormat:
2119
raise TestSkipped("Format %s is not initializable." % format)
2121
def make_repository(self, relpath, shared=False, format=None):
2122
"""Create a repository on our default transport at relpath.
2124
Note that relpath must be a relative path, not a full url.
2126
# FIXME: If you create a remoterepository this returns the underlying
2127
# real format, which is incorrect. Actually we should make sure that
2128
# RemoteBzrDir returns a RemoteRepository.
2129
# maybe mbp 20070410
2130
made_control = self.make_bzrdir(relpath, format=format)
2131
return made_control.create_repository(shared=shared)
2133
def make_smart_server(self, path):
2134
smart_server = server.SmartTCPServer_for_testing()
2135
smart_server.setUp(self.get_server())
2136
remote_transport = get_transport(smart_server.get_url()).clone(path)
2137
self.addCleanup(smart_server.tearDown)
2138
return remote_transport
2140
def make_branch_and_memory_tree(self, relpath, format=None):
2141
"""Create a branch on the default transport and a MemoryTree for it."""
2142
b = self.make_branch(relpath, format=format)
2143
return memorytree.MemoryTree.create_on_branch(b)
2145
def make_branch_builder(self, relpath, format=None):
2146
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2149
def overrideEnvironmentForTesting(self):
2150
os.environ['HOME'] = self.test_home_dir
2151
os.environ['BZR_HOME'] = self.test_home_dir
2154
super(TestCaseWithMemoryTransport, self).setUp()
2155
self._make_test_root()
2156
_currentdir = os.getcwdu()
2157
def _leaveDirectory():
2158
os.chdir(_currentdir)
2159
self.addCleanup(_leaveDirectory)
2160
self.makeAndChdirToTestDir()
2161
self.overrideEnvironmentForTesting()
2162
self.__readonly_server = None
2163
self.__server = None
2164
self.reduceLockdirTimeout()
2166
def setup_smart_server_with_call_log(self):
2167
"""Sets up a smart server as the transport server with a call log."""
2168
self.transport_server = server.SmartTCPServer_for_testing
2169
self.hpss_calls = []
2171
# Skip the current stack down to the caller of
2172
# setup_smart_server_with_call_log
2173
prefix_length = len(traceback.extract_stack()) - 2
2174
def capture_hpss_call(params):
2175
self.hpss_calls.append(
2176
CapturedCall(params, prefix_length))
2177
client._SmartClient.hooks.install_named_hook(
2178
'call', capture_hpss_call, None)
2180
def reset_smart_call_log(self):
2181
self.hpss_calls = []
2184
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2185
"""Derived class that runs a test within a temporary directory.
2187
This is useful for tests that need to create a branch, etc.
2189
The directory is created in a slightly complex way: for each
2190
Python invocation, a new temporary top-level directory is created.
2191
All test cases create their own directory within that. If the
2192
tests complete successfully, the directory is removed.
2194
:ivar test_base_dir: The path of the top-level directory for this
2195
test, which contains a home directory and a work directory.
2197
:ivar test_home_dir: An initially empty directory under test_base_dir
2198
which is used as $HOME for this test.
2200
:ivar test_dir: A directory under test_base_dir used as the current
2201
directory when the test proper is run.
2204
OVERRIDE_PYTHON = 'python'
2206
def check_file_contents(self, filename, expect):
2207
self.log("check contents of file %s" % filename)
2208
contents = file(filename, 'r').read()
2209
if contents != expect:
2210
self.log("expected: %r" % expect)
2211
self.log("actually: %r" % contents)
2212
self.fail("contents of %s not as expected" % filename)
2214
def _getTestDirPrefix(self):
2215
# create a directory within the top level test directory
2216
if sys.platform == 'win32':
2217
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2218
# windows is likely to have path-length limits so use a short name
2219
name_prefix = name_prefix[-30:]
2221
name_prefix = re.sub('[/]', '_', self.id())
2224
def makeAndChdirToTestDir(self):
2225
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2227
For TestCaseInTempDir we create a temporary directory based on the test
2228
name and then create two subdirs - test and home under it.
2230
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2232
for i in range(100):
2233
if os.path.exists(name):
2234
name = name_prefix + '_' + str(i)
2238
# now create test and home directories within this dir
2239
self.test_base_dir = name
2240
self.test_home_dir = self.test_base_dir + '/home'
2241
os.mkdir(self.test_home_dir)
2242
self.test_dir = self.test_base_dir + '/work'
2243
os.mkdir(self.test_dir)
2244
os.chdir(self.test_dir)
2245
# put name of test inside
2246
f = file(self.test_base_dir + '/name', 'w')
2251
self.addCleanup(self.deleteTestDir)
2253
def deleteTestDir(self):
2254
os.chdir(self.TEST_ROOT)
2255
_rmtree_temp_dir(self.test_base_dir)
2257
def build_tree(self, shape, line_endings='binary', transport=None):
2258
"""Build a test tree according to a pattern.
2260
shape is a sequence of file specifications. If the final
2261
character is '/', a directory is created.
2263
This assumes that all the elements in the tree being built are new.
2265
This doesn't add anything to a branch.
2267
:type shape: list or tuple.
2268
:param line_endings: Either 'binary' or 'native'
2269
in binary mode, exact contents are written in native mode, the
2270
line endings match the default platform endings.
2271
:param transport: A transport to write to, for building trees on VFS's.
2272
If the transport is readonly or None, "." is opened automatically.
2275
if type(shape) not in (list, tuple):
2276
raise AssertionError("Parameter 'shape' should be "
2277
"a list or a tuple. Got %r instead" % (shape,))
2278
# It's OK to just create them using forward slashes on windows.
2279
if transport is None or transport.is_readonly():
2280
transport = get_transport(".")
2282
self.assertIsInstance(name, basestring)
2284
transport.mkdir(urlutils.escape(name[:-1]))
2286
if line_endings == 'binary':
2288
elif line_endings == 'native':
2291
raise errors.BzrError(
2292
'Invalid line ending request %r' % line_endings)
2293
content = "contents of %s%s" % (name.encode('utf-8'), end)
2294
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2296
def build_tree_contents(self, shape):
2297
build_tree_contents(shape)
2299
def assertInWorkingTree(self, path, root_path='.', tree=None):
2300
"""Assert whether path or paths are in the WorkingTree"""
2302
tree = workingtree.WorkingTree.open(root_path)
2303
if not isinstance(path, basestring):
2305
self.assertInWorkingTree(p, tree=tree)
2307
self.assertIsNot(tree.path2id(path), None,
2308
path+' not in working tree.')
2310
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2311
"""Assert whether path or paths are not in the WorkingTree"""
2313
tree = workingtree.WorkingTree.open(root_path)
2314
if not isinstance(path, basestring):
2316
self.assertNotInWorkingTree(p,tree=tree)
2318
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2321
class TestCaseWithTransport(TestCaseInTempDir):
2322
"""A test case that provides get_url and get_readonly_url facilities.
2324
These back onto two transport servers, one for readonly access and one for
2327
If no explicit class is provided for readonly access, a
2328
ReadonlyTransportDecorator is used instead which allows the use of non disk
2329
based read write transports.
2331
If an explicit class is provided for readonly access, that server and the
2332
readwrite one must both define get_url() as resolving to os.getcwd().
2335
def get_vfs_only_server(self):
2336
"""See TestCaseWithMemoryTransport.
2338
This is useful for some tests with specific servers that need
2341
if self.__vfs_server is None:
2342
self.__vfs_server = self.vfs_transport_factory()
2343
self.__vfs_server.setUp()
2344
self.addCleanup(self.__vfs_server.tearDown)
2345
return self.__vfs_server
2347
def make_branch_and_tree(self, relpath, format=None):
2348
"""Create a branch on the transport and a tree locally.
2350
If the transport is not a LocalTransport, the Tree can't be created on
2351
the transport. In that case if the vfs_transport_factory is
2352
LocalURLServer the working tree is created in the local
2353
directory backing the transport, and the returned tree's branch and
2354
repository will also be accessed locally. Otherwise a lightweight
2355
checkout is created and returned.
2357
:param format: The BzrDirFormat.
2358
:returns: the WorkingTree.
2360
# TODO: always use the local disk path for the working tree,
2361
# this obviously requires a format that supports branch references
2362
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2364
b = self.make_branch(relpath, format=format)
2366
return b.bzrdir.create_workingtree()
2367
except errors.NotLocalUrl:
2368
# We can only make working trees locally at the moment. If the
2369
# transport can't support them, then we keep the non-disk-backed
2370
# branch and create a local checkout.
2371
if self.vfs_transport_factory is LocalURLServer:
2372
# the branch is colocated on disk, we cannot create a checkout.
2373
# hopefully callers will expect this.
2374
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2375
wt = local_controldir.create_workingtree()
2376
if wt.branch._format != b._format:
2378
# Make sure that assigning to wt._branch fixes wt.branch,
2379
# in case the implementation details of workingtree objects
2381
self.assertIs(b, wt.branch)
2384
return b.create_checkout(relpath, lightweight=True)
2386
def assertIsDirectory(self, relpath, transport):
2387
"""Assert that relpath within transport is a directory.
2389
This may not be possible on all transports; in that case it propagates
2390
a TransportNotPossible.
2393
mode = transport.stat(relpath).st_mode
2394
except errors.NoSuchFile:
2395
self.fail("path %s is not a directory; no such file"
2397
if not stat.S_ISDIR(mode):
2398
self.fail("path %s is not a directory; has mode %#o"
2401
def assertTreesEqual(self, left, right):
2402
"""Check that left and right have the same content and properties."""
2403
# we use a tree delta to check for equality of the content, and we
2404
# manually check for equality of other things such as the parents list.
2405
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2406
differences = left.changes_from(right)
2407
self.assertFalse(differences.has_changed(),
2408
"Trees %r and %r are different: %r" % (left, right, differences))
2411
super(TestCaseWithTransport, self).setUp()
2412
self.__vfs_server = None
2415
class ChrootedTestCase(TestCaseWithTransport):
2416
"""A support class that provides readonly urls outside the local namespace.
2418
This is done by checking if self.transport_server is a MemoryServer. if it
2419
is then we are chrooted already, if it is not then an HttpServer is used
2422
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2423
be used without needed to redo it when a different
2424
subclass is in use ?
2428
super(ChrootedTestCase, self).setUp()
2429
if not self.vfs_transport_factory == MemoryServer:
2430
self.transport_readonly_server = HttpServer
2433
def condition_id_re(pattern):
2434
"""Create a condition filter which performs a re check on a test's id.
2436
:param pattern: A regular expression string.
2437
:return: A callable that returns True if the re matches.
2439
filter_re = osutils.re_compile_checked(pattern, 0,
2441
def condition(test):
2443
return filter_re.search(test_id)
2447
def condition_isinstance(klass_or_klass_list):
2448
"""Create a condition filter which returns isinstance(param, klass).
2450
:return: A callable which when called with one parameter obj return the
2451
result of isinstance(obj, klass_or_klass_list).
2454
return isinstance(obj, klass_or_klass_list)
2458
def condition_id_in_list(id_list):
2459
"""Create a condition filter which verify that test's id in a list.
2461
:param id_list: A TestIdList object.
2462
:return: A callable that returns True if the test's id appears in the list.
2464
def condition(test):
2465
return id_list.includes(test.id())
2469
def condition_id_startswith(starts):
2470
"""Create a condition filter verifying that test's id starts with a string.
2472
:param starts: A list of string.
2473
:return: A callable that returns True if the test's id starts with one of
2476
def condition(test):
2477
for start in starts:
2478
if test.id().startswith(start):
2484
def exclude_tests_by_condition(suite, condition):
2485
"""Create a test suite which excludes some tests from suite.
2487
:param suite: The suite to get tests from.
2488
:param condition: A callable whose result evaluates True when called with a
2489
test case which should be excluded from the result.
2490
:return: A suite which contains the tests found in suite that fail
2494
for test in iter_suite_tests(suite):
2495
if not condition(test):
2497
return TestUtil.TestSuite(result)
2500
def filter_suite_by_condition(suite, condition):
2501
"""Create a test suite by filtering another one.
2503
:param suite: The source suite.
2504
:param condition: A callable whose result evaluates True when called with a
2505
test case which should be included in the result.
2506
:return: A suite which contains the tests found in suite that pass
2510
for test in iter_suite_tests(suite):
2513
return TestUtil.TestSuite(result)
2516
def filter_suite_by_re(suite, pattern):
2517
"""Create a test suite by filtering another one.
2519
:param suite: the source suite
2520
:param pattern: pattern that names must match
2521
:returns: the newly created suite
2523
condition = condition_id_re(pattern)
2524
result_suite = filter_suite_by_condition(suite, condition)
2528
def filter_suite_by_id_list(suite, test_id_list):
2529
"""Create a test suite by filtering another one.
2531
:param suite: The source suite.
2532
:param test_id_list: A list of the test ids to keep as strings.
2533
:returns: the newly created suite
2535
condition = condition_id_in_list(test_id_list)
2536
result_suite = filter_suite_by_condition(suite, condition)
2540
def filter_suite_by_id_startswith(suite, start):
2541
"""Create a test suite by filtering another one.
2543
:param suite: The source suite.
2544
:param start: A list of string the test id must start with one of.
2545
:returns: the newly created suite
2547
condition = condition_id_startswith(start)
2548
result_suite = filter_suite_by_condition(suite, condition)
2552
def exclude_tests_by_re(suite, pattern):
2553
"""Create a test suite which excludes some tests from suite.
2555
:param suite: The suite to get tests from.
2556
:param pattern: A regular expression string. Test ids that match this
2557
pattern will be excluded from the result.
2558
:return: A TestSuite that contains all the tests from suite without the
2559
tests that matched pattern. The order of tests is the same as it was in
2562
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2565
def preserve_input(something):
2566
"""A helper for performing test suite transformation chains.
2568
:param something: Anything you want to preserve.
2574
def randomize_suite(suite):
2575
"""Return a new TestSuite with suite's tests in random order.
2577
The tests in the input suite are flattened into a single suite in order to
2578
accomplish this. Any nested TestSuites are removed to provide global
2581
tests = list(iter_suite_tests(suite))
2582
random.shuffle(tests)
2583
return TestUtil.TestSuite(tests)
2586
def split_suite_by_condition(suite, condition):
2587
"""Split a test suite into two by a condition.
2589
:param suite: The suite to split.
2590
:param condition: The condition to match on. Tests that match this
2591
condition are returned in the first test suite, ones that do not match
2592
are in the second suite.
2593
:return: A tuple of two test suites, where the first contains tests from
2594
suite matching the condition, and the second contains the remainder
2595
from suite. The order within each output suite is the same as it was in
2600
for test in iter_suite_tests(suite):
2602
matched.append(test)
2604
did_not_match.append(test)
2605
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2608
def split_suite_by_re(suite, pattern):
2609
"""Split a test suite into two by a regular expression.
2611
:param suite: The suite to split.
2612
:param pattern: A regular expression string. Test ids that match this
2613
pattern will be in the first test suite returned, and the others in the
2614
second test suite returned.
2615
:return: A tuple of two test suites, where the first contains tests from
2616
suite matching pattern, and the second contains the remainder from
2617
suite. The order within each output suite is the same as it was in
2620
return split_suite_by_condition(suite, condition_id_re(pattern))
2623
def run_suite(suite, name='test', verbose=False, pattern=".*",
2624
stop_on_failure=False,
2625
transport=None, lsprof_timed=None, bench_history=None,
2626
matching_tests_first=None,
2629
exclude_pattern=None,
2632
"""Run a test suite for bzr selftest.
2634
:param runner_class: The class of runner to use. Must support the
2635
constructor arguments passed by run_suite which are more than standard
2637
:return: A boolean indicating success.
2639
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2644
if runner_class is None:
2645
runner_class = TextTestRunner
2646
runner = runner_class(stream=sys.stdout,
2648
verbosity=verbosity,
2649
bench_history=bench_history,
2650
list_only=list_only,
2652
runner.stop_on_failure=stop_on_failure
2653
# Initialise the random number generator and display the seed used.
2654
# We convert the seed to a long to make it reuseable across invocations.
2655
random_order = False
2656
if random_seed is not None:
2658
if random_seed == "now":
2659
random_seed = long(time.time())
2661
# Convert the seed to a long if we can
2663
random_seed = long(random_seed)
2666
runner.stream.writeln("Randomizing test order using seed %s\n" %
2668
random.seed(random_seed)
2669
# Customise the list of tests if requested
2670
if exclude_pattern is not None:
2671
suite = exclude_tests_by_re(suite, exclude_pattern)
2673
order_changer = randomize_suite
2675
order_changer = preserve_input
2676
if pattern != '.*' or random_order:
2677
if matching_tests_first:
2678
suites = map(order_changer, split_suite_by_re(suite, pattern))
2679
suite = TestUtil.TestSuite(suites)
2681
suite = order_changer(filter_suite_by_re(suite, pattern))
2683
result = runner.run(suite)
2686
return result.wasStrictlySuccessful()
2688
return result.wasSuccessful()
2691
# Controlled by "bzr selftest -E=..." option
2692
selftest_debug_flags = set()
2695
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2697
test_suite_factory=None,
2700
matching_tests_first=None,
2703
exclude_pattern=None,
2710
"""Run the whole test suite under the enhanced runner"""
2711
# XXX: Very ugly way to do this...
2712
# Disable warning about old formats because we don't want it to disturb
2713
# any blackbox tests.
2714
from bzrlib import repository
2715
repository._deprecation_warning_done = True
2717
global default_transport
2718
if transport is None:
2719
transport = default_transport
2720
old_transport = default_transport
2721
default_transport = transport
2722
global selftest_debug_flags
2723
old_debug_flags = selftest_debug_flags
2724
if debug_flags is not None:
2725
selftest_debug_flags = set(debug_flags)
2727
if load_list is None:
2730
keep_only = load_test_id_list(load_list)
2731
if test_suite_factory is None:
2732
suite = test_suite(keep_only, starting_with)
2734
suite = test_suite_factory()
2735
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2736
stop_on_failure=stop_on_failure,
2737
transport=transport,
2738
lsprof_timed=lsprof_timed,
2739
bench_history=bench_history,
2740
matching_tests_first=matching_tests_first,
2741
list_only=list_only,
2742
random_seed=random_seed,
2743
exclude_pattern=exclude_pattern,
2745
runner_class=runner_class,
2748
default_transport = old_transport
2749
selftest_debug_flags = old_debug_flags
2752
def load_test_id_list(file_name):
2753
"""Load a test id list from a text file.
2755
The format is one test id by line. No special care is taken to impose
2756
strict rules, these test ids are used to filter the test suite so a test id
2757
that do not match an existing test will do no harm. This allows user to add
2758
comments, leave blank lines, etc.
2762
ftest = open(file_name, 'rt')
2764
if e.errno != errno.ENOENT:
2767
raise errors.NoSuchFile(file_name)
2769
for test_name in ftest.readlines():
2770
test_list.append(test_name.strip())
2775
def suite_matches_id_list(test_suite, id_list):
2776
"""Warns about tests not appearing or appearing more than once.
2778
:param test_suite: A TestSuite object.
2779
:param test_id_list: The list of test ids that should be found in
2782
:return: (absents, duplicates) absents is a list containing the test found
2783
in id_list but not in test_suite, duplicates is a list containing the
2784
test found multiple times in test_suite.
2786
When using a prefined test id list, it may occurs that some tests do not
2787
exist anymore or that some tests use the same id. This function warns the
2788
tester about potential problems in his workflow (test lists are volatile)
2789
or in the test suite itself (using the same id for several tests does not
2790
help to localize defects).
2792
# Build a dict counting id occurrences
2794
for test in iter_suite_tests(test_suite):
2796
tests[id] = tests.get(id, 0) + 1
2801
occurs = tests.get(id, 0)
2803
not_found.append(id)
2805
duplicates.append(id)
2807
return not_found, duplicates
2810
class TestIdList(object):
2811
"""Test id list to filter a test suite.
2813
Relying on the assumption that test ids are built as:
2814
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2815
notation, this class offers methods to :
2816
- avoid building a test suite for modules not refered to in the test list,
2817
- keep only the tests listed from the module test suite.
2820
def __init__(self, test_id_list):
2821
# When a test suite needs to be filtered against us we compare test ids
2822
# for equality, so a simple dict offers a quick and simple solution.
2823
self.tests = dict().fromkeys(test_id_list, True)
2825
# While unittest.TestCase have ids like:
2826
# <module>.<class>.<method>[(<param+)],
2827
# doctest.DocTestCase can have ids like:
2830
# <module>.<function>
2831
# <module>.<class>.<method>
2833
# Since we can't predict a test class from its name only, we settle on
2834
# a simple constraint: a test id always begins with its module name.
2837
for test_id in test_id_list:
2838
parts = test_id.split('.')
2839
mod_name = parts.pop(0)
2840
modules[mod_name] = True
2842
mod_name += '.' + part
2843
modules[mod_name] = True
2844
self.modules = modules
2846
def refers_to(self, module_name):
2847
"""Is there tests for the module or one of its sub modules."""
2848
return self.modules.has_key(module_name)
2850
def includes(self, test_id):
2851
return self.tests.has_key(test_id)
2854
class TestPrefixAliasRegistry(registry.Registry):
2855
"""A registry for test prefix aliases.
2857
This helps implement shorcuts for the --starting-with selftest
2858
option. Overriding existing prefixes is not allowed but not fatal (a
2859
warning will be emitted).
2862
def register(self, key, obj, help=None, info=None,
2863
override_existing=False):
2864
"""See Registry.register.
2866
Trying to override an existing alias causes a warning to be emitted,
2867
not a fatal execption.
2870
super(TestPrefixAliasRegistry, self).register(
2871
key, obj, help=help, info=info, override_existing=False)
2873
actual = self.get(key)
2874
note('Test prefix alias %s is already used for %s, ignoring %s'
2875
% (key, actual, obj))
2877
def resolve_alias(self, id_start):
2878
"""Replace the alias by the prefix in the given string.
2880
Using an unknown prefix is an error to help catching typos.
2882
parts = id_start.split('.')
2884
parts[0] = self.get(parts[0])
2886
raise errors.BzrCommandError(
2887
'%s is not a known test prefix alias' % parts[0])
2888
return '.'.join(parts)
2891
test_prefix_alias_registry = TestPrefixAliasRegistry()
2892
"""Registry of test prefix aliases."""
2895
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2896
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2897
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2899
# Obvious higest levels prefixes, feel free to add your own via a plugin
2900
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2901
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2902
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2903
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2904
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2907
def test_suite(keep_only=None, starting_with=None):
2908
"""Build and return TestSuite for the whole of bzrlib.
2910
:param keep_only: A list of test ids limiting the suite returned.
2912
:param starting_with: An id limiting the suite returned to the tests
2915
This function can be replaced if you need to change the default test
2916
suite on a global basis, but it is not encouraged.
2920
'bzrlib.tests.blackbox',
2921
'bzrlib.tests.branch_implementations',
2922
'bzrlib.tests.bzrdir_implementations',
2923
'bzrlib.tests.commands',
2924
'bzrlib.tests.interrepository_implementations',
2925
'bzrlib.tests.intertree_implementations',
2926
'bzrlib.tests.inventory_implementations',
2927
'bzrlib.tests.per_interbranch',
2928
'bzrlib.tests.per_lock',
2929
'bzrlib.tests.per_repository',
2930
'bzrlib.tests.per_repository_reference',
2931
'bzrlib.tests.test__dirstate_helpers',
2932
'bzrlib.tests.test__walkdirs_win32',
2933
'bzrlib.tests.test_ancestry',
2934
'bzrlib.tests.test_annotate',
2935
'bzrlib.tests.test_api',
2936
'bzrlib.tests.test_atomicfile',
2937
'bzrlib.tests.test_bad_files',
2938
'bzrlib.tests.test_bisect_multi',
2939
'bzrlib.tests.test_branch',
2940
'bzrlib.tests.test_branchbuilder',
2941
'bzrlib.tests.test_btree_index',
2942
'bzrlib.tests.test_bugtracker',
2943
'bzrlib.tests.test_bundle',
2944
'bzrlib.tests.test_bzrdir',
2945
'bzrlib.tests.test_cache_utf8',
2946
'bzrlib.tests.test_clean_tree',
2947
'bzrlib.tests.test_chunk_writer',
2948
'bzrlib.tests.test__chunks_to_lines',
2949
'bzrlib.tests.test_commands',
2950
'bzrlib.tests.test_commit',
2951
'bzrlib.tests.test_commit_merge',
2952
'bzrlib.tests.test_config',
2953
'bzrlib.tests.test_conflicts',
2954
'bzrlib.tests.test_counted_lock',
2955
'bzrlib.tests.test_decorators',
2956
'bzrlib.tests.test_delta',
2957
'bzrlib.tests.test_debug',
2958
'bzrlib.tests.test_deprecated_graph',
2959
'bzrlib.tests.test_diff',
2960
'bzrlib.tests.test_directory_service',
2961
'bzrlib.tests.test_dirstate',
2962
'bzrlib.tests.test_email_message',
2963
'bzrlib.tests.test_errors',
2964
'bzrlib.tests.test_export',
2965
'bzrlib.tests.test_extract',
2966
'bzrlib.tests.test_fetch',
2967
'bzrlib.tests.test_fifo_cache',
2968
'bzrlib.tests.test_filters',
2969
'bzrlib.tests.test_ftp_transport',
2970
'bzrlib.tests.test_foreign',
2971
'bzrlib.tests.test_generate_docs',
2972
'bzrlib.tests.test_generate_ids',
2973
'bzrlib.tests.test_globbing',
2974
'bzrlib.tests.test_gpg',
2975
'bzrlib.tests.test_graph',
2976
'bzrlib.tests.test_hashcache',
2977
'bzrlib.tests.test_help',
2978
'bzrlib.tests.test_hooks',
2979
'bzrlib.tests.test_http',
2980
'bzrlib.tests.test_http_implementations',
2981
'bzrlib.tests.test_http_response',
2982
'bzrlib.tests.test_https_ca_bundle',
2983
'bzrlib.tests.test_identitymap',
2984
'bzrlib.tests.test_ignores',
2985
'bzrlib.tests.test_index',
2986
'bzrlib.tests.test_info',
2987
'bzrlib.tests.test_inv',
2988
'bzrlib.tests.test_inventory_delta',
2989
'bzrlib.tests.test_knit',
2990
'bzrlib.tests.test_lazy_import',
2991
'bzrlib.tests.test_lazy_regex',
2992
'bzrlib.tests.test_lockable_files',
2993
'bzrlib.tests.test_lockdir',
2994
'bzrlib.tests.test_log',
2995
'bzrlib.tests.test_lru_cache',
2996
'bzrlib.tests.test_lsprof',
2997
'bzrlib.tests.test_mail_client',
2998
'bzrlib.tests.test_memorytree',
2999
'bzrlib.tests.test_merge',
3000
'bzrlib.tests.test_merge3',
3001
'bzrlib.tests.test_merge_core',
3002
'bzrlib.tests.test_merge_directive',
3003
'bzrlib.tests.test_missing',
3004
'bzrlib.tests.test_msgeditor',
3005
'bzrlib.tests.test_multiparent',
3006
'bzrlib.tests.test_mutabletree',
3007
'bzrlib.tests.test_nonascii',
3008
'bzrlib.tests.test_options',
3009
'bzrlib.tests.test_osutils',
3010
'bzrlib.tests.test_osutils_encodings',
3011
'bzrlib.tests.test_pack',
3012
'bzrlib.tests.test_pack_repository',
3013
'bzrlib.tests.test_patch',
3014
'bzrlib.tests.test_patches',
3015
'bzrlib.tests.test_permissions',
3016
'bzrlib.tests.test_plugins',
3017
'bzrlib.tests.test_progress',
3018
'bzrlib.tests.test_read_bundle',
3019
'bzrlib.tests.test_reconcile',
3020
'bzrlib.tests.test_reconfigure',
3021
'bzrlib.tests.test_registry',
3022
'bzrlib.tests.test_remote',
3023
'bzrlib.tests.test_rename_map',
3024
'bzrlib.tests.test_repository',
3025
'bzrlib.tests.test_revert',
3026
'bzrlib.tests.test_revision',
3027
'bzrlib.tests.test_revisionspec',
3028
'bzrlib.tests.test_revisiontree',
3029
'bzrlib.tests.test_rio',
3030
'bzrlib.tests.test_rules',
3031
'bzrlib.tests.test_sampler',
3032
'bzrlib.tests.test_selftest',
3033
'bzrlib.tests.test_setup',
3034
'bzrlib.tests.test_sftp_transport',
3035
'bzrlib.tests.test_shelf',
3036
'bzrlib.tests.test_shelf_ui',
3037
'bzrlib.tests.test_smart',
3038
'bzrlib.tests.test_smart_add',
3039
'bzrlib.tests.test_smart_request',
3040
'bzrlib.tests.test_smart_transport',
3041
'bzrlib.tests.test_smtp_connection',
3042
'bzrlib.tests.test_source',
3043
'bzrlib.tests.test_ssh_transport',
3044
'bzrlib.tests.test_status',
3045
'bzrlib.tests.test_store',
3046
'bzrlib.tests.test_strace',
3047
'bzrlib.tests.test_subsume',
3048
'bzrlib.tests.test_switch',
3049
'bzrlib.tests.test_symbol_versioning',
3050
'bzrlib.tests.test_tag',
3051
'bzrlib.tests.test_testament',
3052
'bzrlib.tests.test_textfile',
3053
'bzrlib.tests.test_textmerge',
3054
'bzrlib.tests.test_timestamp',
3055
'bzrlib.tests.test_trace',
3056
'bzrlib.tests.test_transactions',
3057
'bzrlib.tests.test_transform',
3058
'bzrlib.tests.test_transport',
3059
'bzrlib.tests.test_transport_implementations',
3060
'bzrlib.tests.test_transport_log',
3061
'bzrlib.tests.test_tree',
3062
'bzrlib.tests.test_treebuilder',
3063
'bzrlib.tests.test_tsort',
3064
'bzrlib.tests.test_tuned_gzip',
3065
'bzrlib.tests.test_ui',
3066
'bzrlib.tests.test_uncommit',
3067
'bzrlib.tests.test_upgrade',
3068
'bzrlib.tests.test_upgrade_stacked',
3069
'bzrlib.tests.test_urlutils',
3070
'bzrlib.tests.test_version',
3071
'bzrlib.tests.test_version_info',
3072
'bzrlib.tests.test_versionedfile',
3073
'bzrlib.tests.test_weave',
3074
'bzrlib.tests.test_whitebox',
3075
'bzrlib.tests.test_win32utils',
3076
'bzrlib.tests.test_workingtree',
3077
'bzrlib.tests.test_workingtree_4',
3078
'bzrlib.tests.test_wsgi',
3079
'bzrlib.tests.test_xml',
3080
'bzrlib.tests.tree_implementations',
3081
'bzrlib.tests.workingtree_implementations',
3082
'bzrlib.util.tests.test_bencode',
3085
loader = TestUtil.TestLoader()
3088
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3089
for start in starting_with]
3090
# We take precedence over keep_only because *at loading time* using
3091
# both options means we will load less tests for the same final result.
3092
def interesting_module(name):
3093
for start in starting_with:
3095
# Either the module name starts with the specified string
3096
name.startswith(start)
3097
# or it may contain tests starting with the specified string
3098
or start.startswith(name)
3102
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3104
elif keep_only is not None:
3105
id_filter = TestIdList(keep_only)
3106
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3107
def interesting_module(name):
3108
return id_filter.refers_to(name)
3111
loader = TestUtil.TestLoader()
3112
def interesting_module(name):
3113
# No filtering, all modules are interesting
3116
suite = loader.suiteClass()
3118
# modules building their suite with loadTestsFromModuleNames
3119
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3121
modules_to_doctest = [
3123
'bzrlib.branchbuilder',
3126
'bzrlib.iterablefile',
3130
'bzrlib.symbol_versioning',
3133
'bzrlib.version_info_formats.format_custom',
3136
for mod in modules_to_doctest:
3137
if not interesting_module(mod):
3138
# No tests to keep here, move along
3141
# note that this really does mean "report only" -- doctest
3142
# still runs the rest of the examples
3143
doc_suite = doctest.DocTestSuite(mod,
3144
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3145
except ValueError, e:
3146
print '**failed to get doctest for: %s\n%s' % (mod, e)
3148
if len(doc_suite._tests) == 0:
3149
raise errors.BzrError("no doctests found in %s" % (mod,))
3150
suite.addTest(doc_suite)
3152
default_encoding = sys.getdefaultencoding()
3153
for name, plugin in bzrlib.plugin.plugins().items():
3154
if not interesting_module(plugin.module.__name__):
3156
plugin_suite = plugin.test_suite()
3157
# We used to catch ImportError here and turn it into just a warning,
3158
# but really if you don't have --no-plugins this should be a failure.
3159
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3160
if plugin_suite is None:
3161
plugin_suite = plugin.load_plugin_tests(loader)
3162
if plugin_suite is not None:
3163
suite.addTest(plugin_suite)
3164
if default_encoding != sys.getdefaultencoding():
3165
bzrlib.trace.warning(
3166
'Plugin "%s" tried to reset default encoding to: %s', name,
3167
sys.getdefaultencoding())
3169
sys.setdefaultencoding(default_encoding)
3172
suite = filter_suite_by_id_startswith(suite, starting_with)
3174
if keep_only is not None:
3175
# Now that the referred modules have loaded their tests, keep only the
3177
suite = filter_suite_by_id_list(suite, id_filter)
3178
# Do some sanity checks on the id_list filtering
3179
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3181
# The tester has used both keep_only and starting_with, so he is
3182
# already aware that some tests are excluded from the list, there
3183
# is no need to tell him which.
3186
# Some tests mentioned in the list are not in the test suite. The
3187
# list may be out of date, report to the tester.
3188
for id in not_found:
3189
bzrlib.trace.warning('"%s" not found in the test suite', id)
3190
for id in duplicates:
3191
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3196
def multiply_scenarios(scenarios_left, scenarios_right):
3197
"""Multiply two sets of scenarios.
3199
:returns: the cartesian product of the two sets of scenarios, that is
3200
a scenario for every possible combination of a left scenario and a
3204
('%s,%s' % (left_name, right_name),
3205
dict(left_dict.items() + right_dict.items()))
3206
for left_name, left_dict in scenarios_left
3207
for right_name, right_dict in scenarios_right]
3210
def multiply_tests(tests, scenarios, result):
3211
"""Multiply tests_list by scenarios into result.
3213
This is the core workhorse for test parameterisation.
3215
Typically the load_tests() method for a per-implementation test suite will
3216
call multiply_tests and return the result.
3218
:param tests: The tests to parameterise.
3219
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3220
scenario_param_dict).
3221
:param result: A TestSuite to add created tests to.
3223
This returns the passed in result TestSuite with the cross product of all
3224
the tests repeated once for each scenario. Each test is adapted by adding
3225
the scenario name at the end of its id(), and updating the test object's
3226
__dict__ with the scenario_param_dict.
3228
>>> r = multiply_tests(
3229
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3230
... [('one', dict(param=1)),
3231
... ('two', dict(param=2))],
3233
>>> tests = list(iter_suite_tests(r))
3237
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3243
for test in iter_suite_tests(tests):
3244
apply_scenarios(test, scenarios, result)
3248
def apply_scenarios(test, scenarios, result):
3249
"""Apply the scenarios in scenarios to test and add to result.
3251
:param test: The test to apply scenarios to.
3252
:param scenarios: An iterable of scenarios to apply to test.
3254
:seealso: apply_scenario
3256
for scenario in scenarios:
3257
result.addTest(apply_scenario(test, scenario))
3261
def apply_scenario(test, scenario):
3262
"""Copy test and apply scenario to it.
3264
:param test: A test to adapt.
3265
:param scenario: A tuple describing the scenarion.
3266
The first element of the tuple is the new test id.
3267
The second element is a dict containing attributes to set on the
3269
:return: The adapted test.
3271
new_id = "%s(%s)" % (test.id(), scenario[0])
3272
new_test = clone_test(test, new_id)
3273
for name, value in scenario[1].items():
3274
setattr(new_test, name, value)
3278
def clone_test(test, new_id):
3279
"""Clone a test giving it a new id.
3281
:param test: The test to clone.
3282
:param new_id: The id to assign to it.
3283
:return: The new test.
3285
from copy import deepcopy
3286
new_test = deepcopy(test)
3287
new_test.id = lambda: new_id
3291
def _rmtree_temp_dir(dirname):
3292
# If LANG=C we probably have created some bogus paths
3293
# which rmtree(unicode) will fail to delete
3294
# so make sure we are using rmtree(str) to delete everything
3295
# except on win32, where rmtree(str) will fail
3296
# since it doesn't have the property of byte-stream paths
3297
# (they are either ascii or mbcs)
3298
if sys.platform == 'win32':
3299
# make sure we are using the unicode win32 api
3300
dirname = unicode(dirname)
3302
dirname = dirname.encode(sys.getfilesystemencoding())
3304
osutils.rmtree(dirname)
3306
if sys.platform == 'win32' and e.errno == errno.EACCES:
3307
sys.stderr.write(('Permission denied: '
3308
'unable to remove testing dir '
3309
'%s\n' % os.path.basename(dirname)))
3314
class Feature(object):
3315
"""An operating system Feature."""
3318
self._available = None
3320
def available(self):
3321
"""Is the feature available?
3323
:return: True if the feature is available.
3325
if self._available is None:
3326
self._available = self._probe()
3327
return self._available
3330
"""Implement this method in concrete features.
3332
:return: True if the feature is available.
3334
raise NotImplementedError
3337
if getattr(self, 'feature_name', None):
3338
return self.feature_name()
3339
return self.__class__.__name__
3342
class _SymlinkFeature(Feature):
3345
return osutils.has_symlinks()
3347
def feature_name(self):
3350
SymlinkFeature = _SymlinkFeature()
3353
class _HardlinkFeature(Feature):
3356
return osutils.has_hardlinks()
3358
def feature_name(self):
3361
HardlinkFeature = _HardlinkFeature()
3364
class _OsFifoFeature(Feature):
3367
return getattr(os, 'mkfifo', None)
3369
def feature_name(self):
3370
return 'filesystem fifos'
3372
OsFifoFeature = _OsFifoFeature()
3375
class _UnicodeFilenameFeature(Feature):
3376
"""Does the filesystem support Unicode filenames?"""
3380
# Check for character combinations unlikely to be covered by any
3381
# single non-unicode encoding. We use the characters
3382
# - greek small letter alpha (U+03B1) and
3383
# - braille pattern dots-123456 (U+283F).
3384
os.stat(u'\u03b1\u283f')
3385
except UnicodeEncodeError:
3387
except (IOError, OSError):
3388
# The filesystem allows the Unicode filename but the file doesn't
3392
# The filesystem allows the Unicode filename and the file exists,
3396
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3399
def probe_unicode_in_user_encoding():
3400
"""Try to encode several unicode strings to use in unicode-aware tests.
3401
Return first successfull match.
3403
:return: (unicode value, encoded plain string value) or (None, None)
3405
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3406
for uni_val in possible_vals:
3408
str_val = uni_val.encode(osutils.get_user_encoding())
3409
except UnicodeEncodeError:
3410
# Try a different character
3413
return uni_val, str_val
3417
def probe_bad_non_ascii(encoding):
3418
"""Try to find [bad] character with code [128..255]
3419
that cannot be decoded to unicode in some encoding.
3420
Return None if all non-ascii characters is valid
3423
for i in xrange(128, 256):
3426
char.decode(encoding)
3427
except UnicodeDecodeError:
3432
class _HTTPSServerFeature(Feature):
3433
"""Some tests want an https Server, check if one is available.
3435
Right now, the only way this is available is under python2.6 which provides
3446
def feature_name(self):
3447
return 'HTTPSServer'
3450
HTTPSServerFeature = _HTTPSServerFeature()
3453
class _UnicodeFilename(Feature):
3454
"""Does the filesystem support Unicode filenames?"""
3459
except UnicodeEncodeError:
3461
except (IOError, OSError):
3462
# The filesystem allows the Unicode filename but the file doesn't
3466
# The filesystem allows the Unicode filename and the file exists,
3470
UnicodeFilename = _UnicodeFilename()
3473
class _UTF8Filesystem(Feature):
3474
"""Is the filesystem UTF-8?"""
3477
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3481
UTF8Filesystem = _UTF8Filesystem()
3484
class _CaseInsCasePresFilenameFeature(Feature):
3485
"""Is the file-system case insensitive, but case-preserving?"""
3488
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3490
# first check truly case-preserving for created files, then check
3491
# case insensitive when opening existing files.
3492
name = osutils.normpath(name)
3493
base, rel = osutils.split(name)
3494
found_rel = osutils.canonical_relpath(base, name)
3495
return (found_rel == rel
3496
and os.path.isfile(name.upper())
3497
and os.path.isfile(name.lower()))
3502
def feature_name(self):
3503
return "case-insensitive case-preserving filesystem"
3505
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3508
class _CaseInsensitiveFilesystemFeature(Feature):
3509
"""Check if underlying filesystem is case-insensitive but *not* case
3512
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3513
# more likely to be case preserving, so this case is rare.
3516
if CaseInsCasePresFilenameFeature.available():
3519
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3520
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3521
TestCaseWithMemoryTransport.TEST_ROOT = root
3523
root = TestCaseWithMemoryTransport.TEST_ROOT
3524
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3526
name_a = osutils.pathjoin(tdir, 'a')
3527
name_A = osutils.pathjoin(tdir, 'A')
3529
result = osutils.isdir(name_A)
3530
_rmtree_temp_dir(tdir)
3533
def feature_name(self):
3534
return 'case-insensitive filesystem'
3536
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3539
class _SubUnitFeature(Feature):
3540
"""Check if subunit is available."""
3549
def feature_name(self):
3552
SubUnitFeature = _SubUnitFeature()
3553
# Only define SubUnitBzrRunner if subunit is available.
3555
from subunit import TestProtocolClient
3556
class SubUnitBzrRunner(TextTestRunner):
3557
def run(self, test):
3558
# undo out claim for testing which looks like a test start to subunit
3559
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3560
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
