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, server
82
from bzrlib import symbol_versioning
83
from bzrlib.symbol_versioning import (
90
from bzrlib.transport import get_transport
91
import bzrlib.transport
92
from bzrlib.transport.local import LocalURLServer
93
from bzrlib.transport.memory import MemoryServer
94
from bzrlib.transport.readonly import ReadonlyServer
95
from bzrlib.trace import mutter, note
96
from bzrlib.tests import TestUtil
97
from bzrlib.tests.http_server import HttpServer
98
from bzrlib.tests.TestUtil import (
102
from bzrlib.tests.treeshape import build_tree_contents
103
import bzrlib.version_info_formats.format_custom
104
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
106
# Mark this python module as being part of the implementation
107
# of unittest: this gives us better tracebacks where the last
108
# shown frame is the test code, not our assertXYZ.
111
default_transport = LocalURLServer
114
class ExtendedTestResult(unittest._TextTestResult):
115
"""Accepts, reports and accumulates the results of running tests.
117
Compared to the unittest version this class adds support for
118
profiling, benchmarking, stopping as soon as a test fails, and
119
skipping tests. There are further-specialized subclasses for
120
different types of display.
122
When a test finishes, in whatever way, it calls one of the addSuccess,
123
addFailure or addError classes. These in turn may redirect to a more
124
specific case for the special test results supported by our extended
127
Note that just one of these objects is fed the results from many tests.
132
def __init__(self, stream, descriptions, verbosity,
136
"""Construct new TestResult.
138
:param bench_history: Optionally, a writable file object to accumulate
141
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
142
if bench_history is not None:
143
from bzrlib.version import _get_bzr_source_tree
144
src_tree = _get_bzr_source_tree()
147
revision_id = src_tree.get_parent_ids()[0]
149
# XXX: if this is a brand new tree, do the same as if there
153
# XXX: If there's no branch, what should we do?
155
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
156
self._bench_history = bench_history
157
self.ui = ui.ui_factory
158
self.num_tests = num_tests
160
self.failure_count = 0
161
self.known_failure_count = 0
163
self.not_applicable_count = 0
164
self.unsupported = {}
166
self._overall_start_time = time.time()
168
def _extractBenchmarkTime(self, testCase):
169
"""Add a benchmark time for the current test case."""
170
return getattr(testCase, "_benchtime", None)
172
def _elapsedTestTimeString(self):
173
"""Return a time string for the overall time the current test has taken."""
174
return self._formatTime(time.time() - self._start_time)
176
def _testTimeString(self, testCase):
177
benchmark_time = self._extractBenchmarkTime(testCase)
178
if benchmark_time is not None:
180
self._formatTime(benchmark_time),
181
self._elapsedTestTimeString())
183
return " %s" % self._elapsedTestTimeString()
185
def _formatTime(self, seconds):
186
"""Format seconds as milliseconds with leading spaces."""
187
# some benchmarks can take thousands of seconds to run, so we need 8
189
return "%8dms" % (1000 * seconds)
191
def _shortened_test_description(self, test):
193
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
196
def startTest(self, test):
197
unittest.TestResult.startTest(self, test)
198
self.report_test_start(test)
199
test.number = self.count
200
self._recordTestStartTime()
202
def _recordTestStartTime(self):
203
"""Record that a test has started."""
204
self._start_time = time.time()
206
def _cleanupLogFile(self, test):
207
# We can only do this if we have one of our TestCases, not if
209
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
210
if setKeepLogfile is not None:
213
def addError(self, test, err):
214
"""Tell result that test finished with an error.
216
Called from the TestCase run() method when the test
217
fails with an unexpected error.
219
self._testConcluded(test)
220
if isinstance(err[1], TestNotApplicable):
221
return self._addNotApplicable(test, err)
222
elif isinstance(err[1], UnavailableFeature):
223
return self.addNotSupported(test, err[1].args[0])
225
unittest.TestResult.addError(self, test, err)
226
self.error_count += 1
227
self.report_error(test, err)
230
self._cleanupLogFile(test)
232
def addFailure(self, test, err):
233
"""Tell result that test failed.
235
Called from the TestCase run() method when the test
236
fails because e.g. an assert() method failed.
238
self._testConcluded(test)
239
if isinstance(err[1], KnownFailure):
240
return self._addKnownFailure(test, err)
242
unittest.TestResult.addFailure(self, test, err)
243
self.failure_count += 1
244
self.report_failure(test, err)
247
self._cleanupLogFile(test)
249
def addSuccess(self, test):
250
"""Tell result that test completed successfully.
252
Called from the TestCase run()
254
self._testConcluded(test)
255
if self._bench_history is not None:
256
benchmark_time = self._extractBenchmarkTime(test)
257
if benchmark_time is not None:
258
self._bench_history.write("%s %s\n" % (
259
self._formatTime(benchmark_time),
261
self.report_success(test)
262
self._cleanupLogFile(test)
263
unittest.TestResult.addSuccess(self, test)
264
test._log_contents = ''
266
def _testConcluded(self, test):
267
"""Common code when a test has finished.
269
Called regardless of whether it succeded, failed, etc.
273
def _addKnownFailure(self, test, err):
274
self.known_failure_count += 1
275
self.report_known_failure(test, err)
277
def addNotSupported(self, test, feature):
278
"""The test will not be run because of a missing feature.
280
# this can be called in two different ways: it may be that the
281
# test started running, and then raised (through addError)
282
# UnavailableFeature. Alternatively this method can be called
283
# while probing for features before running the tests; in that
284
# case we will see startTest and stopTest, but the test will never
286
self.unsupported.setdefault(str(feature), 0)
287
self.unsupported[str(feature)] += 1
288
self.report_unsupported(test, feature)
290
def addSkip(self, test, reason):
291
"""A test has not run for 'reason'."""
293
self.report_skip(test, reason)
295
def _addNotApplicable(self, test, skip_excinfo):
296
if isinstance(skip_excinfo[1], TestNotApplicable):
297
self.not_applicable_count += 1
298
self.report_not_applicable(test, skip_excinfo)
301
except KeyboardInterrupt:
304
self.addError(test, test.exc_info())
306
# seems best to treat this as success from point-of-view of unittest
307
# -- it actually does nothing so it barely matters :)
308
unittest.TestResult.addSuccess(self, test)
309
test._log_contents = ''
311
def printErrorList(self, flavour, errors):
312
for test, err in errors:
313
self.stream.writeln(self.separator1)
314
self.stream.write("%s: " % flavour)
315
self.stream.writeln(self.getDescription(test))
316
if getattr(test, '_get_log', None) is not None:
317
self.stream.write('\n')
319
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
321
self.stream.write(test._get_log())
322
self.stream.write('\n')
324
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
325
self.stream.write('\n')
326
self.stream.writeln(self.separator2)
327
self.stream.writeln("%s" % err)
332
def report_cleaning_up(self):
335
def report_success(self, test):
338
def wasStrictlySuccessful(self):
339
if self.unsupported or self.known_failure_count:
341
return self.wasSuccessful()
344
class TextTestResult(ExtendedTestResult):
345
"""Displays progress and results of tests in text form"""
347
def __init__(self, stream, descriptions, verbosity,
352
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
353
bench_history, num_tests)
355
self.pb = self.ui.nested_progress_bar()
356
self._supplied_pb = False
359
self._supplied_pb = True
360
self.pb.show_pct = False
361
self.pb.show_spinner = False
362
self.pb.show_eta = False,
363
self.pb.show_count = False
364
self.pb.show_bar = False
366
def report_starting(self):
367
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
369
def _progress_prefix_text(self):
370
# the longer this text, the less space we have to show the test
372
a = '[%d' % self.count # total that have been run
373
# tests skipped as known not to be relevant are not important enough
375
## if self.skip_count:
376
## a += ', %d skip' % self.skip_count
377
## if self.known_failure_count:
378
## a += '+%dX' % self.known_failure_count
379
if self.num_tests is not None:
380
a +='/%d' % self.num_tests
382
runtime = time.time() - self._overall_start_time
384
a += '%dm%ds' % (runtime / 60, runtime % 60)
388
a += ', %d err' % self.error_count
389
if self.failure_count:
390
a += ', %d fail' % self.failure_count
392
a += ', %d missing' % len(self.unsupported)
396
def report_test_start(self, test):
399
self._progress_prefix_text()
401
+ self._shortened_test_description(test))
403
def _test_description(self, test):
404
return self._shortened_test_description(test)
406
def report_error(self, test, err):
407
self.pb.note('ERROR: %s\n %s\n',
408
self._test_description(test),
412
def report_failure(self, test, err):
413
self.pb.note('FAIL: %s\n %s\n',
414
self._test_description(test),
418
def report_known_failure(self, test, err):
419
self.pb.note('XFAIL: %s\n%s\n',
420
self._test_description(test), err[1])
422
def report_skip(self, test, reason):
425
def report_not_applicable(self, test, skip_excinfo):
428
def report_unsupported(self, test, feature):
429
"""test cannot be run because feature is missing."""
431
def report_cleaning_up(self):
432
self.pb.update('Cleaning up')
435
if not self._supplied_pb:
439
class VerboseTestResult(ExtendedTestResult):
440
"""Produce long output, with one line per test run plus times"""
442
def _ellipsize_to_right(self, a_string, final_width):
443
"""Truncate and pad a string, keeping the right hand side"""
444
if len(a_string) > final_width:
445
result = '...' + a_string[3-final_width:]
448
return result.ljust(final_width)
450
def report_starting(self):
451
self.stream.write('running %d tests...\n' % self.num_tests)
453
def report_test_start(self, test):
455
name = self._shortened_test_description(test)
456
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
457
# numbers, plus a trailing blank
458
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
459
self.stream.write(self._ellipsize_to_right(name,
460
osutils.terminal_width()-30))
463
def _error_summary(self, err):
465
return '%s%s' % (indent, err[1])
467
def report_error(self, test, err):
468
self.stream.writeln('ERROR %s\n%s'
469
% (self._testTimeString(test),
470
self._error_summary(err)))
472
def report_failure(self, test, err):
473
self.stream.writeln(' FAIL %s\n%s'
474
% (self._testTimeString(test),
475
self._error_summary(err)))
477
def report_known_failure(self, test, err):
478
self.stream.writeln('XFAIL %s\n%s'
479
% (self._testTimeString(test),
480
self._error_summary(err)))
482
def report_success(self, test):
483
self.stream.writeln(' OK %s' % self._testTimeString(test))
484
for bench_called, stats in getattr(test, '_benchcalls', []):
485
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
486
stats.pprint(file=self.stream)
487
# flush the stream so that we get smooth output. This verbose mode is
488
# used to show the output in PQM.
491
def report_skip(self, test, reason):
492
self.stream.writeln(' SKIP %s\n%s'
493
% (self._testTimeString(test), reason))
495
def report_not_applicable(self, test, skip_excinfo):
496
self.stream.writeln(' N/A %s\n%s'
497
% (self._testTimeString(test),
498
self._error_summary(skip_excinfo)))
500
def report_unsupported(self, test, feature):
501
"""test cannot be run because feature is missing."""
502
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
503
%(self._testTimeString(test), feature))
506
class TextTestRunner(object):
507
stop_on_failure = False
516
self.stream = unittest._WritelnDecorator(stream)
517
self.descriptions = descriptions
518
self.verbosity = verbosity
519
self._bench_history = bench_history
520
self.list_only = list_only
523
"Run the given test case or test suite."
524
startTime = time.time()
525
if self.verbosity == 1:
526
result_class = TextTestResult
527
elif self.verbosity >= 2:
528
result_class = VerboseTestResult
529
result = result_class(self.stream,
532
bench_history=self._bench_history,
533
num_tests=test.countTestCases(),
535
result.stop_early = self.stop_on_failure
536
result.report_starting()
538
if self.verbosity >= 2:
539
self.stream.writeln("Listing tests only ...\n")
541
for t in iter_suite_tests(test):
542
self.stream.writeln("%s" % (t.id()))
544
actionTaken = "Listed"
547
run = result.testsRun
549
stopTime = time.time()
550
timeTaken = stopTime - startTime
552
self.stream.writeln(result.separator2)
553
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
554
run, run != 1 and "s" or "", timeTaken))
555
self.stream.writeln()
556
if not result.wasSuccessful():
557
self.stream.write("FAILED (")
558
failed, errored = map(len, (result.failures, result.errors))
560
self.stream.write("failures=%d" % failed)
562
if failed: self.stream.write(", ")
563
self.stream.write("errors=%d" % errored)
564
if result.known_failure_count:
565
if failed or errored: self.stream.write(", ")
566
self.stream.write("known_failure_count=%d" %
567
result.known_failure_count)
568
self.stream.writeln(")")
570
if result.known_failure_count:
571
self.stream.writeln("OK (known_failures=%d)" %
572
result.known_failure_count)
574
self.stream.writeln("OK")
575
if result.skip_count > 0:
576
skipped = result.skip_count
577
self.stream.writeln('%d test%s skipped' %
578
(skipped, skipped != 1 and "s" or ""))
579
if result.unsupported:
580
for feature, count in sorted(result.unsupported.items()):
581
self.stream.writeln("Missing feature '%s' skipped %d tests." %
587
def iter_suite_tests(suite):
588
"""Return all tests in a suite, recursing through nested suites"""
589
if isinstance(suite, unittest.TestCase):
591
elif isinstance(suite, unittest.TestSuite):
592
for item in suite._tests:
593
for r in iter_suite_tests(item):
596
raise Exception('unknown type %r for object %r'
597
% (type(suite), suite))
600
class TestSkipped(Exception):
601
"""Indicates that a test was intentionally skipped, rather than failing."""
604
class TestNotApplicable(TestSkipped):
605
"""A test is not applicable to the situation where it was run.
607
This is only normally raised by parameterized tests, if they find that
608
the instance they're constructed upon does not support one aspect
613
class KnownFailure(AssertionError):
614
"""Indicates that a test failed in a precisely expected manner.
616
Such failures dont block the whole test suite from passing because they are
617
indicators of partially completed code or of future work. We have an
618
explicit error for them so that we can ensure that they are always visible:
619
KnownFailures are always shown in the output of bzr selftest.
623
class UnavailableFeature(Exception):
624
"""A feature required for this test was not available.
626
The feature should be used to construct the exception.
630
class CommandFailed(Exception):
634
class StringIOWrapper(object):
635
"""A wrapper around cStringIO which just adds an encoding attribute.
637
Internally we can check sys.stdout to see what the output encoding
638
should be. However, cStringIO has no encoding attribute that we can
639
set. So we wrap it instead.
644
def __init__(self, s=None):
646
self.__dict__['_cstring'] = StringIO(s)
648
self.__dict__['_cstring'] = StringIO()
650
def __getattr__(self, name, getattr=getattr):
651
return getattr(self.__dict__['_cstring'], name)
653
def __setattr__(self, name, val):
654
if name == 'encoding':
655
self.__dict__['encoding'] = val
657
return setattr(self._cstring, name, val)
660
class TestUIFactory(ui.CLIUIFactory):
661
"""A UI Factory for testing.
663
Hide the progress bar but emit note()s.
665
Allows get_password to be tested without real tty attached.
672
super(TestUIFactory, self).__init__()
673
if stdin is not None:
674
# We use a StringIOWrapper to be able to test various
675
# encodings, but the user is still responsible to
676
# encode the string and to set the encoding attribute
677
# of StringIOWrapper.
678
self.stdin = StringIOWrapper(stdin)
680
self.stdout = sys.stdout
684
self.stderr = sys.stderr
689
"""See progress.ProgressBar.clear()."""
691
def clear_term(self):
692
"""See progress.ProgressBar.clear_term()."""
694
def clear_term(self):
695
"""See progress.ProgressBar.clear_term()."""
698
"""See progress.ProgressBar.finished()."""
700
def note(self, fmt_string, *args, **kwargs):
701
"""See progress.ProgressBar.note()."""
702
self.stdout.write((fmt_string + "\n") % args)
704
def progress_bar(self):
707
def nested_progress_bar(self):
710
def update(self, message, count=None, total=None):
711
"""See progress.ProgressBar.update()."""
713
def get_non_echoed_password(self, prompt):
714
"""Get password from stdin without trying to handle the echo mode"""
716
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
717
password = self.stdin.readline()
720
if password[-1] == '\n':
721
password = password[:-1]
725
def _report_leaked_threads():
726
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
727
TestCase._first_thread_leaker_id,
728
TestCase._leaking_threads_tests)
731
class TestCase(unittest.TestCase):
732
"""Base class for bzr unit tests.
734
Tests that need access to disk resources should subclass
735
TestCaseInTempDir not TestCase.
737
Error and debug log messages are redirected from their usual
738
location into a temporary file, the contents of which can be
739
retrieved by _get_log(). We use a real OS file, not an in-memory object,
740
so that it can also capture file IO. When the test completes this file
741
is read into memory and removed from disk.
743
There are also convenience functions to invoke bzr's command-line
744
routine, and to build and check bzr trees.
746
In addition to the usual method of overriding tearDown(), this class also
747
allows subclasses to register functions into the _cleanups list, which is
748
run in order as the object is torn down. It's less likely this will be
749
accidentally overlooked.
752
_active_threads = None
753
_leaking_threads_tests = 0
754
_first_thread_leaker_id = None
755
_log_file_name = None
757
_keep_log_file = False
758
# record lsprof data when performing benchmark calls.
759
_gather_lsprof_in_benchmarks = False
760
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
761
'_log_contents', '_log_file_name', '_benchtime',
762
'_TestCase__testMethodName')
764
def __init__(self, methodName='testMethod'):
765
super(TestCase, self).__init__(methodName)
767
self._bzr_test_setUp_run = False
768
self._bzr_test_tearDown_run = False
771
unittest.TestCase.setUp(self)
772
self._bzr_test_setUp_run = True
773
self._cleanEnvironment()
776
self._benchcalls = []
777
self._benchtime = None
779
self._clear_debug_flags()
780
TestCase._active_threads = threading.activeCount()
781
self.addCleanup(self._check_leaked_threads)
786
pdb.Pdb().set_trace(sys._getframe().f_back)
789
absent_attr = object()
790
exc_info = getattr(self, '_exc_info', absent_attr)
791
if exc_info is absent_attr:
792
exc_info = getattr(self, '_TestCase__exc_info')
795
def _check_leaked_threads(self):
796
active = threading.activeCount()
797
leaked_threads = active - TestCase._active_threads
798
TestCase._active_threads = active
800
TestCase._leaking_threads_tests += 1
801
if TestCase._first_thread_leaker_id is None:
802
TestCase._first_thread_leaker_id = self.id()
803
# we're not specifically told when all tests are finished.
804
# This will do. We use a function to avoid keeping a reference
805
# to a TestCase object.
806
atexit.register(_report_leaked_threads)
808
def _clear_debug_flags(self):
809
"""Prevent externally set debug flags affecting tests.
811
Tests that want to use debug flags can just set them in the
812
debug_flags set during setup/teardown.
814
self._preserved_debug_flags = set(debug.debug_flags)
815
if 'allow_debug' not in selftest_debug_flags:
816
debug.debug_flags.clear()
817
self.addCleanup(self._restore_debug_flags)
819
def _clear_hooks(self):
820
# prevent hooks affecting tests
821
self._preserved_hooks = {}
822
for key, factory in hooks.known_hooks.items():
823
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
824
current_hooks = hooks.known_hooks_key_to_object(key)
825
self._preserved_hooks[parent] = (name, current_hooks)
826
self.addCleanup(self._restoreHooks)
827
for key, factory in hooks.known_hooks.items():
828
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
829
setattr(parent, name, factory())
831
def _silenceUI(self):
832
"""Turn off UI for duration of test"""
833
# by default the UI is off; tests can turn it on if they want it.
834
saved = ui.ui_factory
836
ui.ui_factory = saved
837
ui.ui_factory = ui.SilentUIFactory()
838
self.addCleanup(_restore)
840
def _ndiff_strings(self, a, b):
841
"""Return ndiff between two strings containing lines.
843
A trailing newline is added if missing to make the strings
845
if b and b[-1] != '\n':
847
if a and a[-1] != '\n':
849
difflines = difflib.ndiff(a.splitlines(True),
851
linejunk=lambda x: False,
852
charjunk=lambda x: False)
853
return ''.join(difflines)
855
def assertEqual(self, a, b, message=''):
859
except UnicodeError, e:
860
# If we can't compare without getting a UnicodeError, then
861
# obviously they are different
862
mutter('UnicodeError: %s', e)
865
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
867
pformat(a), pformat(b)))
869
assertEquals = assertEqual
871
def assertEqualDiff(self, a, b, message=None):
872
"""Assert two texts are equal, if not raise an exception.
874
This is intended for use with multi-line strings where it can
875
be hard to find the differences by eye.
877
# TODO: perhaps override assertEquals to call this for strings?
881
message = "texts not equal:\n"
883
message = 'first string is missing a final newline.\n'
885
message = 'second string is missing a final newline.\n'
886
raise AssertionError(message +
887
self._ndiff_strings(a, b))
889
def assertEqualMode(self, mode, mode_test):
890
self.assertEqual(mode, mode_test,
891
'mode mismatch %o != %o' % (mode, mode_test))
893
def assertEqualStat(self, expected, actual):
894
"""assert that expected and actual are the same stat result.
896
:param expected: A stat result.
897
:param actual: A stat result.
898
:raises AssertionError: If the expected and actual stat values differ
901
self.assertEqual(expected.st_size, actual.st_size)
902
self.assertEqual(expected.st_mtime, actual.st_mtime)
903
self.assertEqual(expected.st_ctime, actual.st_ctime)
904
self.assertEqual(expected.st_dev, actual.st_dev)
905
self.assertEqual(expected.st_ino, actual.st_ino)
906
self.assertEqual(expected.st_mode, actual.st_mode)
908
def assertLength(self, length, obj_with_len):
909
"""Assert that obj_with_len is of length length."""
910
if len(obj_with_len) != length:
911
self.fail("Incorrect length: wanted %d, got %d for %r" % (
912
length, len(obj_with_len), obj_with_len))
914
def assertPositive(self, val):
915
"""Assert that val is greater than 0."""
916
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
918
def assertNegative(self, val):
919
"""Assert that val is less than 0."""
920
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
922
def assertStartsWith(self, s, prefix):
923
if not s.startswith(prefix):
924
raise AssertionError('string %r does not start with %r' % (s, prefix))
926
def assertEndsWith(self, s, suffix):
927
"""Asserts that s ends with suffix."""
928
if not s.endswith(suffix):
929
raise AssertionError('string %r does not end with %r' % (s, suffix))
931
def assertContainsRe(self, haystack, needle_re, flags=0):
932
"""Assert that a contains something matching a regular expression."""
933
if not re.search(needle_re, haystack, flags):
934
if '\n' in haystack or len(haystack) > 60:
935
# a long string, format it in a more readable way
936
raise AssertionError(
937
'pattern "%s" not found in\n"""\\\n%s"""\n'
938
% (needle_re, haystack))
940
raise AssertionError('pattern "%s" not found in "%s"'
941
% (needle_re, haystack))
943
def assertNotContainsRe(self, haystack, needle_re, flags=0):
944
"""Assert that a does not match a regular expression"""
945
if re.search(needle_re, haystack, flags):
946
raise AssertionError('pattern "%s" found in "%s"'
947
% (needle_re, haystack))
949
def assertSubset(self, sublist, superlist):
950
"""Assert that every entry in sublist is present in superlist."""
951
missing = set(sublist) - set(superlist)
953
raise AssertionError("value(s) %r not present in container %r" %
954
(missing, superlist))
956
def assertListRaises(self, excClass, func, *args, **kwargs):
957
"""Fail unless excClass is raised when the iterator from func is used.
959
Many functions can return generators this makes sure
960
to wrap them in a list() call to make sure the whole generator
961
is run, and that the proper exception is raised.
964
list(func(*args, **kwargs))
968
if getattr(excClass,'__name__', None) is not None:
969
excName = excClass.__name__
971
excName = str(excClass)
972
raise self.failureException, "%s not raised" % excName
974
def assertRaises(self, excClass, callableObj, *args, **kwargs):
975
"""Assert that a callable raises a particular exception.
977
:param excClass: As for the except statement, this may be either an
978
exception class, or a tuple of classes.
979
:param callableObj: A callable, will be passed ``*args`` and
982
Returns the exception so that you can examine it.
985
callableObj(*args, **kwargs)
989
if getattr(excClass,'__name__', None) is not None:
990
excName = excClass.__name__
993
excName = str(excClass)
994
raise self.failureException, "%s not raised" % excName
996
def assertIs(self, left, right, message=None):
997
if not (left is right):
998
if message is not None:
999
raise AssertionError(message)
1001
raise AssertionError("%r is not %r." % (left, right))
1003
def assertIsNot(self, left, right, message=None):
1005
if message is not None:
1006
raise AssertionError(message)
1008
raise AssertionError("%r is %r." % (left, right))
1010
def assertTransportMode(self, transport, path, mode):
1011
"""Fail if a path does not have mode mode.
1013
If modes are not supported on this transport, the assertion is ignored.
1015
if not transport._can_roundtrip_unix_modebits():
1017
path_stat = transport.stat(path)
1018
actual_mode = stat.S_IMODE(path_stat.st_mode)
1019
self.assertEqual(mode, actual_mode,
1020
'mode of %r incorrect (%s != %s)'
1021
% (path, oct(mode), oct(actual_mode)))
1023
def assertIsSameRealPath(self, path1, path2):
1024
"""Fail if path1 and path2 points to different files"""
1025
self.assertEqual(osutils.realpath(path1),
1026
osutils.realpath(path2),
1027
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1029
def assertIsInstance(self, obj, kls):
1030
"""Fail if obj is not an instance of kls"""
1031
if not isinstance(obj, kls):
1032
self.fail("%r is an instance of %s rather than %s" % (
1033
obj, obj.__class__, kls))
1035
def expectFailure(self, reason, assertion, *args, **kwargs):
1036
"""Invoke a test, expecting it to fail for the given reason.
1038
This is for assertions that ought to succeed, but currently fail.
1039
(The failure is *expected* but not *wanted*.) Please be very precise
1040
about the failure you're expecting. If a new bug is introduced,
1041
AssertionError should be raised, not KnownFailure.
1043
Frequently, expectFailure should be followed by an opposite assertion.
1046
Intended to be used with a callable that raises AssertionError as the
1047
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1049
Raises KnownFailure if the test fails. Raises AssertionError if the
1054
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1056
self.assertEqual(42, dynamic_val)
1058
This means that a dynamic_val of 54 will cause the test to raise
1059
a KnownFailure. Once math is fixed and the expectFailure is removed,
1060
only a dynamic_val of 42 will allow the test to pass. Anything other
1061
than 54 or 42 will cause an AssertionError.
1064
assertion(*args, **kwargs)
1065
except AssertionError:
1066
raise KnownFailure(reason)
1068
self.fail('Unexpected success. Should have failed: %s' % reason)
1070
def assertFileEqual(self, content, path):
1071
"""Fail if path does not contain 'content'."""
1072
self.failUnlessExists(path)
1073
f = file(path, 'rb')
1078
self.assertEqualDiff(content, s)
1080
def failUnlessExists(self, path):
1081
"""Fail unless path or paths, which may be abs or relative, exist."""
1082
if not isinstance(path, basestring):
1084
self.failUnlessExists(p)
1086
self.failUnless(osutils.lexists(path),path+" does not exist")
1088
def failIfExists(self, path):
1089
"""Fail if path or paths, which may be abs or relative, exist."""
1090
if not isinstance(path, basestring):
1092
self.failIfExists(p)
1094
self.failIf(osutils.lexists(path),path+" exists")
1096
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1097
"""A helper for callDeprecated and applyDeprecated.
1099
:param a_callable: A callable to call.
1100
:param args: The positional arguments for the callable
1101
:param kwargs: The keyword arguments for the callable
1102
:return: A tuple (warnings, result). result is the result of calling
1103
a_callable(``*args``, ``**kwargs``).
1106
def capture_warnings(msg, cls=None, stacklevel=None):
1107
# we've hooked into a deprecation specific callpath,
1108
# only deprecations should getting sent via it.
1109
self.assertEqual(cls, DeprecationWarning)
1110
local_warnings.append(msg)
1111
original_warning_method = symbol_versioning.warn
1112
symbol_versioning.set_warning_method(capture_warnings)
1114
result = a_callable(*args, **kwargs)
1116
symbol_versioning.set_warning_method(original_warning_method)
1117
return (local_warnings, result)
1119
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1120
"""Call a deprecated callable without warning the user.
1122
Note that this only captures warnings raised by symbol_versioning.warn,
1123
not other callers that go direct to the warning module.
1125
To test that a deprecated method raises an error, do something like
1128
self.assertRaises(errors.ReservedId,
1129
self.applyDeprecated,
1130
deprecated_in((1, 5, 0)),
1134
:param deprecation_format: The deprecation format that the callable
1135
should have been deprecated with. This is the same type as the
1136
parameter to deprecated_method/deprecated_function. If the
1137
callable is not deprecated with this format, an assertion error
1139
:param a_callable: A callable to call. This may be a bound method or
1140
a regular function. It will be called with ``*args`` and
1142
:param args: The positional arguments for the callable
1143
:param kwargs: The keyword arguments for the callable
1144
:return: The result of a_callable(``*args``, ``**kwargs``)
1146
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1148
expected_first_warning = symbol_versioning.deprecation_string(
1149
a_callable, deprecation_format)
1150
if len(call_warnings) == 0:
1151
self.fail("No deprecation warning generated by call to %s" %
1153
self.assertEqual(expected_first_warning, call_warnings[0])
1156
def callCatchWarnings(self, fn, *args, **kw):
1157
"""Call a callable that raises python warnings.
1159
The caller's responsible for examining the returned warnings.
1161
If the callable raises an exception, the exception is not
1162
caught and propagates up to the caller. In that case, the list
1163
of warnings is not available.
1165
:returns: ([warning_object, ...], fn_result)
1167
# XXX: This is not perfect, because it completely overrides the
1168
# warnings filters, and some code may depend on suppressing particular
1169
# warnings. It's the easiest way to insulate ourselves from -Werror,
1170
# though. -- Andrew, 20071062
1172
def _catcher(message, category, filename, lineno, file=None, line=None):
1173
# despite the name, 'message' is normally(?) a Warning subclass
1175
wlist.append(message)
1176
saved_showwarning = warnings.showwarning
1177
saved_filters = warnings.filters
1179
warnings.showwarning = _catcher
1180
warnings.filters = []
1181
result = fn(*args, **kw)
1183
warnings.showwarning = saved_showwarning
1184
warnings.filters = saved_filters
1185
return wlist, result
1187
def callDeprecated(self, expected, callable, *args, **kwargs):
1188
"""Assert that a callable is deprecated in a particular way.
1190
This is a very precise test for unusual requirements. The
1191
applyDeprecated helper function is probably more suited for most tests
1192
as it allows you to simply specify the deprecation format being used
1193
and will ensure that that is issued for the function being called.
1195
Note that this only captures warnings raised by symbol_versioning.warn,
1196
not other callers that go direct to the warning module. To catch
1197
general warnings, use callCatchWarnings.
1199
:param expected: a list of the deprecation warnings expected, in order
1200
:param callable: The callable to call
1201
:param args: The positional arguments for the callable
1202
:param kwargs: The keyword arguments for the callable
1204
call_warnings, result = self._capture_deprecation_warnings(callable,
1206
self.assertEqual(expected, call_warnings)
1209
def _startLogFile(self):
1210
"""Send bzr and test log messages to a temporary file.
1212
The file is removed as the test is torn down.
1214
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1215
self._log_file = os.fdopen(fileno, 'w+')
1216
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1217
self._log_file_name = name
1218
self.addCleanup(self._finishLogFile)
1220
def _finishLogFile(self):
1221
"""Finished with the log file.
1223
Close the file and delete it, unless setKeepLogfile was called.
1225
if self._log_file is None:
1227
bzrlib.trace.pop_log_file(self._log_memento)
1228
self._log_file.close()
1229
self._log_file = None
1230
if not self._keep_log_file:
1231
os.remove(self._log_file_name)
1232
self._log_file_name = None
1234
def setKeepLogfile(self):
1235
"""Make the logfile not be deleted when _finishLogFile is called."""
1236
self._keep_log_file = True
1238
def addCleanup(self, callable, *args, **kwargs):
1239
"""Arrange to run a callable when this case is torn down.
1241
Callables are run in the reverse of the order they are registered,
1242
ie last-in first-out.
1244
self._cleanups.append((callable, args, kwargs))
1246
def _cleanEnvironment(self):
1248
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1249
'HOME': os.getcwd(),
1250
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1251
# tests do check our impls match APPDATA
1252
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1256
'BZREMAIL': None, # may still be present in the environment
1258
'BZR_PROGRESS_BAR': None,
1260
'BZR_PLUGIN_PATH': None,
1262
'SSH_AUTH_SOCK': None,
1266
'https_proxy': None,
1267
'HTTPS_PROXY': None,
1272
# Nobody cares about these ones AFAIK. So far at
1273
# least. If you do (care), please update this comment
1277
'BZR_REMOTE_PATH': None,
1280
self.addCleanup(self._restoreEnvironment)
1281
for name, value in new_env.iteritems():
1282
self._captureVar(name, value)
1284
def _captureVar(self, name, newvalue):
1285
"""Set an environment variable, and reset it when finished."""
1286
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1288
def _restore_debug_flags(self):
1289
debug.debug_flags.clear()
1290
debug.debug_flags.update(self._preserved_debug_flags)
1292
def _restoreEnvironment(self):
1293
for name, value in self.__old_env.iteritems():
1294
osutils.set_or_unset_env(name, value)
1296
def _restoreHooks(self):
1297
for klass, (name, hooks) in self._preserved_hooks.items():
1298
setattr(klass, name, hooks)
1300
def knownFailure(self, reason):
1301
"""This test has failed for some known reason."""
1302
raise KnownFailure(reason)
1304
def _do_skip(self, result, reason):
1305
addSkip = getattr(result, 'addSkip', None)
1306
if not callable(addSkip):
1307
result.addError(self, self.exc_info())
1309
addSkip(self, reason)
1311
def run(self, result=None):
1312
if result is None: result = self.defaultTestResult()
1313
for feature in getattr(self, '_test_needs_features', []):
1314
if not feature.available():
1315
result.startTest(self)
1316
if getattr(result, 'addNotSupported', None):
1317
result.addNotSupported(self, feature)
1319
result.addSuccess(self)
1320
result.stopTest(self)
1324
result.startTest(self)
1325
absent_attr = object()
1327
method_name = getattr(self, '_testMethodName', absent_attr)
1328
if method_name is absent_attr:
1330
method_name = getattr(self, '_TestCase__testMethodName')
1331
testMethod = getattr(self, method_name)
1335
if not self._bzr_test_setUp_run:
1337
"test setUp did not invoke "
1338
"bzrlib.tests.TestCase's setUp")
1339
except KeyboardInterrupt:
1341
except TestSkipped, e:
1342
self._do_skip(result, e.args[0])
1346
result.addError(self, self.exc_info())
1353
except self.failureException:
1354
result.addFailure(self, self.exc_info())
1355
except TestSkipped, e:
1357
reason = "No reason given."
1360
self._do_skip(result, reason)
1361
except KeyboardInterrupt:
1364
result.addError(self, self.exc_info())
1368
if not self._bzr_test_tearDown_run:
1370
"test tearDown did not invoke "
1371
"bzrlib.tests.TestCase's tearDown")
1372
except KeyboardInterrupt:
1375
result.addError(self, self.exc_info())
1377
if ok: result.addSuccess(self)
1379
result.stopTest(self)
1381
except TestNotApplicable:
1382
# Not moved from the result [yet].
1384
except KeyboardInterrupt:
1388
absent_attr = object()
1389
for attr_name in self.attrs_to_keep:
1390
attr = getattr(self, attr_name, absent_attr)
1391
if attr is not absent_attr:
1392
saved_attrs[attr_name] = attr
1393
self.__dict__ = saved_attrs
1396
self._bzr_test_tearDown_run = True
1398
self._log_contents = ''
1399
unittest.TestCase.tearDown(self)
1401
def time(self, callable, *args, **kwargs):
1402
"""Run callable and accrue the time it takes to the benchmark time.
1404
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1405
this will cause lsprofile statistics to be gathered and stored in
1408
if self._benchtime is None:
1412
if not self._gather_lsprof_in_benchmarks:
1413
return callable(*args, **kwargs)
1415
# record this benchmark
1416
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1418
self._benchcalls.append(((callable, args, kwargs), stats))
1421
self._benchtime += time.time() - start
1423
def _runCleanups(self):
1424
"""Run registered cleanup functions.
1426
This should only be called from TestCase.tearDown.
1428
# TODO: Perhaps this should keep running cleanups even if
1429
# one of them fails?
1431
# Actually pop the cleanups from the list so tearDown running
1432
# twice is safe (this happens for skipped tests).
1433
while self._cleanups:
1434
cleanup, args, kwargs = self._cleanups.pop()
1435
cleanup(*args, **kwargs)
1437
def log(self, *args):
1440
def _get_log(self, keep_log_file=False):
1441
"""Get the log from bzrlib.trace calls from this test.
1443
:param keep_log_file: When True, if the log is still a file on disk
1444
leave it as a file on disk. When False, if the log is still a file
1445
on disk, the log file is deleted and the log preserved as
1447
:return: A string containing the log.
1449
# flush the log file, to get all content
1451
if bzrlib.trace._trace_file:
1452
bzrlib.trace._trace_file.flush()
1453
if self._log_contents:
1454
# XXX: this can hardly contain the content flushed above --vila
1456
return self._log_contents
1457
if self._log_file_name is not None:
1458
logfile = open(self._log_file_name)
1460
log_contents = logfile.read()
1463
if not keep_log_file:
1464
self._log_contents = log_contents
1466
os.remove(self._log_file_name)
1468
if sys.platform == 'win32' and e.errno == errno.EACCES:
1469
sys.stderr.write(('Unable to delete log file '
1470
' %r\n' % self._log_file_name))
1475
return "DELETED log file to reduce memory footprint"
1477
def requireFeature(self, feature):
1478
"""This test requires a specific feature is available.
1480
:raises UnavailableFeature: When feature is not available.
1482
if not feature.available():
1483
raise UnavailableFeature(feature)
1485
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1487
"""Run bazaar command line, splitting up a string command line."""
1488
if isinstance(args, basestring):
1489
# shlex don't understand unicode strings,
1490
# so args should be plain string (bialix 20070906)
1491
args = list(shlex.split(str(args)))
1492
return self._run_bzr_core(args, retcode=retcode,
1493
encoding=encoding, stdin=stdin, working_dir=working_dir,
1496
def _run_bzr_core(self, args, retcode, encoding, stdin,
1498
if encoding is None:
1499
encoding = osutils.get_user_encoding()
1500
stdout = StringIOWrapper()
1501
stderr = StringIOWrapper()
1502
stdout.encoding = encoding
1503
stderr.encoding = encoding
1505
self.log('run bzr: %r', args)
1506
# FIXME: don't call into logging here
1507
handler = logging.StreamHandler(stderr)
1508
handler.setLevel(logging.INFO)
1509
logger = logging.getLogger('')
1510
logger.addHandler(handler)
1511
old_ui_factory = ui.ui_factory
1512
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1515
if working_dir is not None:
1516
cwd = osutils.getcwd()
1517
os.chdir(working_dir)
1520
result = self.apply_redirected(ui.ui_factory.stdin,
1522
bzrlib.commands.run_bzr_catch_user_errors,
1525
logger.removeHandler(handler)
1526
ui.ui_factory = old_ui_factory
1530
out = stdout.getvalue()
1531
err = stderr.getvalue()
1533
self.log('output:\n%r', out)
1535
self.log('errors:\n%r', err)
1536
if retcode is not None:
1537
self.assertEquals(retcode, result,
1538
message='Unexpected return code')
1541
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1542
working_dir=None, error_regexes=[], output_encoding=None):
1543
"""Invoke bzr, as if it were run from the command line.
1545
The argument list should not include the bzr program name - the
1546
first argument is normally the bzr command. Arguments may be
1547
passed in three ways:
1549
1- A list of strings, eg ["commit", "a"]. This is recommended
1550
when the command contains whitespace or metacharacters, or
1551
is built up at run time.
1553
2- A single string, eg "add a". This is the most convenient
1554
for hardcoded commands.
1556
This runs bzr through the interface that catches and reports
1557
errors, and with logging set to something approximating the
1558
default, so that error reporting can be checked.
1560
This should be the main method for tests that want to exercise the
1561
overall behavior of the bzr application (rather than a unit test
1562
or a functional test of the library.)
1564
This sends the stdout/stderr results into the test's log,
1565
where it may be useful for debugging. See also run_captured.
1567
:keyword stdin: A string to be used as stdin for the command.
1568
:keyword retcode: The status code the command should return;
1570
:keyword working_dir: The directory to run the command in
1571
:keyword error_regexes: A list of expected error messages. If
1572
specified they must be seen in the error output of the command.
1574
out, err = self._run_bzr_autosplit(
1579
working_dir=working_dir,
1581
for regex in error_regexes:
1582
self.assertContainsRe(err, regex)
1585
def run_bzr_error(self, error_regexes, *args, **kwargs):
1586
"""Run bzr, and check that stderr contains the supplied regexes
1588
:param error_regexes: Sequence of regular expressions which
1589
must each be found in the error output. The relative ordering
1591
:param args: command-line arguments for bzr
1592
:param kwargs: Keyword arguments which are interpreted by run_bzr
1593
This function changes the default value of retcode to be 3,
1594
since in most cases this is run when you expect bzr to fail.
1596
:return: (out, err) The actual output of running the command (in case
1597
you want to do more inspection)
1601
# Make sure that commit is failing because there is nothing to do
1602
self.run_bzr_error(['no changes to commit'],
1603
['commit', '-m', 'my commit comment'])
1604
# Make sure --strict is handling an unknown file, rather than
1605
# giving us the 'nothing to do' error
1606
self.build_tree(['unknown'])
1607
self.run_bzr_error(['Commit refused because there are unknown files'],
1608
['commit', --strict', '-m', 'my commit comment'])
1610
kwargs.setdefault('retcode', 3)
1611
kwargs['error_regexes'] = error_regexes
1612
out, err = self.run_bzr(*args, **kwargs)
1615
def run_bzr_subprocess(self, *args, **kwargs):
1616
"""Run bzr in a subprocess for testing.
1618
This starts a new Python interpreter and runs bzr in there.
1619
This should only be used for tests that have a justifiable need for
1620
this isolation: e.g. they are testing startup time, or signal
1621
handling, or early startup code, etc. Subprocess code can't be
1622
profiled or debugged so easily.
1624
:keyword retcode: The status code that is expected. Defaults to 0. If
1625
None is supplied, the status code is not checked.
1626
:keyword env_changes: A dictionary which lists changes to environment
1627
variables. A value of None will unset the env variable.
1628
The values must be strings. The change will only occur in the
1629
child, so you don't need to fix the environment after running.
1630
:keyword universal_newlines: Convert CRLF => LF
1631
:keyword allow_plugins: By default the subprocess is run with
1632
--no-plugins to ensure test reproducibility. Also, it is possible
1633
for system-wide plugins to create unexpected output on stderr,
1634
which can cause unnecessary test failures.
1636
env_changes = kwargs.get('env_changes', {})
1637
working_dir = kwargs.get('working_dir', None)
1638
allow_plugins = kwargs.get('allow_plugins', False)
1640
if isinstance(args[0], list):
1642
elif isinstance(args[0], basestring):
1643
args = list(shlex.split(args[0]))
1645
raise ValueError("passing varargs to run_bzr_subprocess")
1646
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1647
working_dir=working_dir,
1648
allow_plugins=allow_plugins)
1649
# We distinguish between retcode=None and retcode not passed.
1650
supplied_retcode = kwargs.get('retcode', 0)
1651
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1652
universal_newlines=kwargs.get('universal_newlines', False),
1655
def start_bzr_subprocess(self, process_args, env_changes=None,
1656
skip_if_plan_to_signal=False,
1658
allow_plugins=False):
1659
"""Start bzr in a subprocess for testing.
1661
This starts a new Python interpreter and runs bzr in there.
1662
This should only be used for tests that have a justifiable need for
1663
this isolation: e.g. they are testing startup time, or signal
1664
handling, or early startup code, etc. Subprocess code can't be
1665
profiled or debugged so easily.
1667
:param process_args: a list of arguments to pass to the bzr executable,
1668
for example ``['--version']``.
1669
:param env_changes: A dictionary which lists changes to environment
1670
variables. A value of None will unset the env variable.
1671
The values must be strings. The change will only occur in the
1672
child, so you don't need to fix the environment after running.
1673
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1675
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1677
:returns: Popen object for the started process.
1679
if skip_if_plan_to_signal:
1680
if not getattr(os, 'kill', None):
1681
raise TestSkipped("os.kill not available.")
1683
if env_changes is None:
1687
def cleanup_environment():
1688
for env_var, value in env_changes.iteritems():
1689
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1691
def restore_environment():
1692
for env_var, value in old_env.iteritems():
1693
osutils.set_or_unset_env(env_var, value)
1695
bzr_path = self.get_bzr_path()
1698
if working_dir is not None:
1699
cwd = osutils.getcwd()
1700
os.chdir(working_dir)
1703
# win32 subprocess doesn't support preexec_fn
1704
# so we will avoid using it on all platforms, just to
1705
# make sure the code path is used, and we don't break on win32
1706
cleanup_environment()
1707
command = [sys.executable]
1708
# frozen executables don't need the path to bzr
1709
if getattr(sys, "frozen", None) is None:
1710
command.append(bzr_path)
1711
if not allow_plugins:
1712
command.append('--no-plugins')
1713
command.extend(process_args)
1714
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1716
restore_environment()
1722
def _popen(self, *args, **kwargs):
1723
"""Place a call to Popen.
1725
Allows tests to override this method to intercept the calls made to
1726
Popen for introspection.
1728
return Popen(*args, **kwargs)
1730
def get_bzr_path(self):
1731
"""Return the path of the 'bzr' executable for this test suite."""
1732
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1733
if not os.path.isfile(bzr_path):
1734
# We are probably installed. Assume sys.argv is the right file
1735
bzr_path = sys.argv[0]
1738
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1739
universal_newlines=False, process_args=None):
1740
"""Finish the execution of process.
1742
:param process: the Popen object returned from start_bzr_subprocess.
1743
:param retcode: The status code that is expected. Defaults to 0. If
1744
None is supplied, the status code is not checked.
1745
:param send_signal: an optional signal to send to the process.
1746
:param universal_newlines: Convert CRLF => LF
1747
:returns: (stdout, stderr)
1749
if send_signal is not None:
1750
os.kill(process.pid, send_signal)
1751
out, err = process.communicate()
1753
if universal_newlines:
1754
out = out.replace('\r\n', '\n')
1755
err = err.replace('\r\n', '\n')
1757
if retcode is not None and retcode != process.returncode:
1758
if process_args is None:
1759
process_args = "(unknown args)"
1760
mutter('Output of bzr %s:\n%s', process_args, out)
1761
mutter('Error for bzr %s:\n%s', process_args, err)
1762
self.fail('Command bzr %s failed with retcode %s != %s'
1763
% (process_args, retcode, process.returncode))
1766
def check_inventory_shape(self, inv, shape):
1767
"""Compare an inventory to a list of expected names.
1769
Fail if they are not precisely equal.
1772
shape = list(shape) # copy
1773
for path, ie in inv.entries():
1774
name = path.replace('\\', '/')
1775
if ie.kind == 'directory':
1782
self.fail("expected paths not found in inventory: %r" % shape)
1784
self.fail("unexpected paths found in inventory: %r" % extras)
1786
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1787
a_callable=None, *args, **kwargs):
1788
"""Call callable with redirected std io pipes.
1790
Returns the return code."""
1791
if not callable(a_callable):
1792
raise ValueError("a_callable must be callable.")
1794
stdin = StringIO("")
1796
if getattr(self, "_log_file", None) is not None:
1797
stdout = self._log_file
1801
if getattr(self, "_log_file", None is not None):
1802
stderr = self._log_file
1805
real_stdin = sys.stdin
1806
real_stdout = sys.stdout
1807
real_stderr = sys.stderr
1812
return a_callable(*args, **kwargs)
1814
sys.stdout = real_stdout
1815
sys.stderr = real_stderr
1816
sys.stdin = real_stdin
1818
def reduceLockdirTimeout(self):
1819
"""Reduce the default lock timeout for the duration of the test, so that
1820
if LockContention occurs during a test, it does so quickly.
1822
Tests that expect to provoke LockContention errors should call this.
1824
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1826
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1827
self.addCleanup(resetTimeout)
1828
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1830
def make_utf8_encoded_stringio(self, encoding_type=None):
1831
"""Return a StringIOWrapper instance, that will encode Unicode
1834
if encoding_type is None:
1835
encoding_type = 'strict'
1837
output_encoding = 'utf-8'
1838
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1839
sio.encoding = output_encoding
1843
class CapturedCall(object):
1844
"""A helper for capturing smart server calls for easy debug analysis."""
1846
def __init__(self, params, prefix_length):
1847
"""Capture the call with params and skip prefix_length stack frames."""
1850
# The last 5 frames are the __init__, the hook frame, and 3 smart
1851
# client frames. Beyond this we could get more clever, but this is good
1853
stack = traceback.extract_stack()[prefix_length:-5]
1854
self.stack = ''.join(traceback.format_list(stack))
1857
return self.call.method
1860
return self.call.method
1866
class TestCaseWithMemoryTransport(TestCase):
1867
"""Common test class for tests that do not need disk resources.
1869
Tests that need disk resources should derive from TestCaseWithTransport.
1871
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1873
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1874
a directory which does not exist. This serves to help ensure test isolation
1875
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1876
must exist. However, TestCaseWithMemoryTransport does not offer local
1877
file defaults for the transport in tests, nor does it obey the command line
1878
override, so tests that accidentally write to the common directory should
1881
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1882
a .bzr directory that stops us ascending higher into the filesystem.
1888
def __init__(self, methodName='runTest'):
1889
# allow test parameterization after test construction and before test
1890
# execution. Variables that the parameterizer sets need to be
1891
# ones that are not set by setUp, or setUp will trash them.
1892
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1893
self.vfs_transport_factory = default_transport
1894
self.transport_server = None
1895
self.transport_readonly_server = None
1896
self.__vfs_server = None
1898
def get_transport(self, relpath=None):
1899
"""Return a writeable transport.
1901
This transport is for the test scratch space relative to
1904
:param relpath: a path relative to the base url.
1906
t = get_transport(self.get_url(relpath))
1907
self.assertFalse(t.is_readonly())
1910
def get_readonly_transport(self, relpath=None):
1911
"""Return a readonly transport for the test scratch space
1913
This can be used to test that operations which should only need
1914
readonly access in fact do not try to write.
1916
:param relpath: a path relative to the base url.
1918
t = get_transport(self.get_readonly_url(relpath))
1919
self.assertTrue(t.is_readonly())
1922
def create_transport_readonly_server(self):
1923
"""Create a transport server from class defined at init.
1925
This is mostly a hook for daughter classes.
1927
return self.transport_readonly_server()
1929
def get_readonly_server(self):
1930
"""Get the server instance for the readonly transport
1932
This is useful for some tests with specific servers to do diagnostics.
1934
if self.__readonly_server is None:
1935
if self.transport_readonly_server is None:
1936
# readonly decorator requested
1937
# bring up the server
1938
self.__readonly_server = ReadonlyServer()
1939
self.__readonly_server.setUp(self.get_vfs_only_server())
1941
self.__readonly_server = self.create_transport_readonly_server()
1942
self.__readonly_server.setUp(self.get_vfs_only_server())
1943
self.addCleanup(self.__readonly_server.tearDown)
1944
return self.__readonly_server
1946
def get_readonly_url(self, relpath=None):
1947
"""Get a URL for the readonly transport.
1949
This will either be backed by '.' or a decorator to the transport
1950
used by self.get_url()
1951
relpath provides for clients to get a path relative to the base url.
1952
These should only be downwards relative, not upwards.
1954
base = self.get_readonly_server().get_url()
1955
return self._adjust_url(base, relpath)
1957
def get_vfs_only_server(self):
1958
"""Get the vfs only read/write server instance.
1960
This is useful for some tests with specific servers that need
1963
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1964
is no means to override it.
1966
if self.__vfs_server is None:
1967
self.__vfs_server = MemoryServer()
1968
self.__vfs_server.setUp()
1969
self.addCleanup(self.__vfs_server.tearDown)
1970
return self.__vfs_server
1972
def get_server(self):
1973
"""Get the read/write server instance.
1975
This is useful for some tests with specific servers that need
1978
This is built from the self.transport_server factory. If that is None,
1979
then the self.get_vfs_server is returned.
1981
if self.__server is None:
1982
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1983
return self.get_vfs_only_server()
1985
# bring up a decorated means of access to the vfs only server.
1986
self.__server = self.transport_server()
1988
self.__server.setUp(self.get_vfs_only_server())
1989
except TypeError, e:
1990
# This should never happen; the try:Except here is to assist
1991
# developers having to update code rather than seeing an
1992
# uninformative TypeError.
1993
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1994
self.addCleanup(self.__server.tearDown)
1995
return self.__server
1997
def _adjust_url(self, base, relpath):
1998
"""Get a URL (or maybe a path) for the readwrite transport.
2000
This will either be backed by '.' or to an equivalent non-file based
2002
relpath provides for clients to get a path relative to the base url.
2003
These should only be downwards relative, not upwards.
2005
if relpath is not None and relpath != '.':
2006
if not base.endswith('/'):
2008
# XXX: Really base should be a url; we did after all call
2009
# get_url()! But sometimes it's just a path (from
2010
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2011
# to a non-escaped local path.
2012
if base.startswith('./') or base.startswith('/'):
2015
base += urlutils.escape(relpath)
2018
def get_url(self, relpath=None):
2019
"""Get a URL (or maybe a path) for the readwrite transport.
2021
This will either be backed by '.' or to an equivalent non-file based
2023
relpath provides for clients to get a path relative to the base url.
2024
These should only be downwards relative, not upwards.
2026
base = self.get_server().get_url()
2027
return self._adjust_url(base, relpath)
2029
def get_vfs_only_url(self, relpath=None):
2030
"""Get a URL (or maybe a path for the plain old vfs transport.
2032
This will never be a smart protocol. It always has all the
2033
capabilities of the local filesystem, but it might actually be a
2034
MemoryTransport or some other similar virtual filesystem.
2036
This is the backing transport (if any) of the server returned by
2037
get_url and get_readonly_url.
2039
:param relpath: provides for clients to get a path relative to the base
2040
url. These should only be downwards relative, not upwards.
2043
base = self.get_vfs_only_server().get_url()
2044
return self._adjust_url(base, relpath)
2046
def _create_safety_net(self):
2047
"""Make a fake bzr directory.
2049
This prevents any tests propagating up onto the TEST_ROOT directory's
2052
root = TestCaseWithMemoryTransport.TEST_ROOT
2053
bzrdir.BzrDir.create_standalone_workingtree(root)
2055
def _check_safety_net(self):
2056
"""Check that the safety .bzr directory have not been touched.
2058
_make_test_root have created a .bzr directory to prevent tests from
2059
propagating. This method ensures than a test did not leaked.
2061
root = TestCaseWithMemoryTransport.TEST_ROOT
2062
wt = workingtree.WorkingTree.open(root)
2063
last_rev = wt.last_revision()
2064
if last_rev != 'null:':
2065
# The current test have modified the /bzr directory, we need to
2066
# recreate a new one or all the followng tests will fail.
2067
# If you need to inspect its content uncomment the following line
2068
# import pdb; pdb.set_trace()
2069
_rmtree_temp_dir(root + '/.bzr')
2070
self._create_safety_net()
2071
raise AssertionError('%s/.bzr should not be modified' % root)
2073
def _make_test_root(self):
2074
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2075
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2076
TestCaseWithMemoryTransport.TEST_ROOT = root
2078
self._create_safety_net()
2080
# The same directory is used by all tests, and we're not
2081
# specifically told when all tests are finished. This will do.
2082
atexit.register(_rmtree_temp_dir, root)
2084
self.addCleanup(self._check_safety_net)
2086
def makeAndChdirToTestDir(self):
2087
"""Create a temporary directories for this one test.
2089
This must set self.test_home_dir and self.test_dir and chdir to
2092
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2094
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2095
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2096
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2098
def make_branch(self, relpath, format=None):
2099
"""Create a branch on the transport at relpath."""
2100
repo = self.make_repository(relpath, format=format)
2101
return repo.bzrdir.create_branch()
2103
def make_bzrdir(self, relpath, format=None):
2105
# might be a relative or absolute path
2106
maybe_a_url = self.get_url(relpath)
2107
segments = maybe_a_url.rsplit('/', 1)
2108
t = get_transport(maybe_a_url)
2109
if len(segments) > 1 and segments[-1] not in ('', '.'):
2113
if isinstance(format, basestring):
2114
format = bzrdir.format_registry.make_bzrdir(format)
2115
return format.initialize_on_transport(t)
2116
except errors.UninitializableFormat:
2117
raise TestSkipped("Format %s is not initializable." % format)
2119
def make_repository(self, relpath, shared=False, format=None):
2120
"""Create a repository on our default transport at relpath.
2122
Note that relpath must be a relative path, not a full url.
2124
# FIXME: If you create a remoterepository this returns the underlying
2125
# real format, which is incorrect. Actually we should make sure that
2126
# RemoteBzrDir returns a RemoteRepository.
2127
# maybe mbp 20070410
2128
made_control = self.make_bzrdir(relpath, format=format)
2129
return made_control.create_repository(shared=shared)
2131
def make_smart_server(self, path):
2132
smart_server = server.SmartTCPServer_for_testing()
2133
smart_server.setUp(self.get_server())
2134
remote_transport = get_transport(smart_server.get_url()).clone(path)
2135
self.addCleanup(smart_server.tearDown)
2136
return remote_transport
2138
def make_branch_and_memory_tree(self, relpath, format=None):
2139
"""Create a branch on the default transport and a MemoryTree for it."""
2140
b = self.make_branch(relpath, format=format)
2141
return memorytree.MemoryTree.create_on_branch(b)
2143
def make_branch_builder(self, relpath, format=None):
2144
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2147
def overrideEnvironmentForTesting(self):
2148
os.environ['HOME'] = self.test_home_dir
2149
os.environ['BZR_HOME'] = self.test_home_dir
2152
super(TestCaseWithMemoryTransport, self).setUp()
2153
self._make_test_root()
2154
_currentdir = os.getcwdu()
2155
def _leaveDirectory():
2156
os.chdir(_currentdir)
2157
self.addCleanup(_leaveDirectory)
2158
self.makeAndChdirToTestDir()
2159
self.overrideEnvironmentForTesting()
2160
self.__readonly_server = None
2161
self.__server = None
2162
self.reduceLockdirTimeout()
2164
def setup_smart_server_with_call_log(self):
2165
"""Sets up a smart server as the transport server with a call log."""
2166
self.transport_server = server.SmartTCPServer_for_testing
2167
self.hpss_calls = []
2169
# Skip the current stack down to the caller of
2170
# setup_smart_server_with_call_log
2171
prefix_length = len(traceback.extract_stack()) - 2
2172
def capture_hpss_call(params):
2173
self.hpss_calls.append(
2174
CapturedCall(params, prefix_length))
2175
client._SmartClient.hooks.install_named_hook(
2176
'call', capture_hpss_call, None)
2178
def reset_smart_call_log(self):
2179
self.hpss_calls = []
2182
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2183
"""Derived class that runs a test within a temporary directory.
2185
This is useful for tests that need to create a branch, etc.
2187
The directory is created in a slightly complex way: for each
2188
Python invocation, a new temporary top-level directory is created.
2189
All test cases create their own directory within that. If the
2190
tests complete successfully, the directory is removed.
2192
:ivar test_base_dir: The path of the top-level directory for this
2193
test, which contains a home directory and a work directory.
2195
:ivar test_home_dir: An initially empty directory under test_base_dir
2196
which is used as $HOME for this test.
2198
:ivar test_dir: A directory under test_base_dir used as the current
2199
directory when the test proper is run.
2202
OVERRIDE_PYTHON = 'python'
2204
def check_file_contents(self, filename, expect):
2205
self.log("check contents of file %s" % filename)
2206
contents = file(filename, 'r').read()
2207
if contents != expect:
2208
self.log("expected: %r" % expect)
2209
self.log("actually: %r" % contents)
2210
self.fail("contents of %s not as expected" % filename)
2212
def _getTestDirPrefix(self):
2213
# create a directory within the top level test directory
2214
if sys.platform == 'win32':
2215
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2216
# windows is likely to have path-length limits so use a short name
2217
name_prefix = name_prefix[-30:]
2219
name_prefix = re.sub('[/]', '_', self.id())
2222
def makeAndChdirToTestDir(self):
2223
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2225
For TestCaseInTempDir we create a temporary directory based on the test
2226
name and then create two subdirs - test and home under it.
2228
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2230
for i in range(100):
2231
if os.path.exists(name):
2232
name = name_prefix + '_' + str(i)
2236
# now create test and home directories within this dir
2237
self.test_base_dir = name
2238
self.test_home_dir = self.test_base_dir + '/home'
2239
os.mkdir(self.test_home_dir)
2240
self.test_dir = self.test_base_dir + '/work'
2241
os.mkdir(self.test_dir)
2242
os.chdir(self.test_dir)
2243
# put name of test inside
2244
f = file(self.test_base_dir + '/name', 'w')
2249
self.addCleanup(self.deleteTestDir)
2251
def deleteTestDir(self):
2252
os.chdir(self.TEST_ROOT)
2253
_rmtree_temp_dir(self.test_base_dir)
2255
def build_tree(self, shape, line_endings='binary', transport=None):
2256
"""Build a test tree according to a pattern.
2258
shape is a sequence of file specifications. If the final
2259
character is '/', a directory is created.
2261
This assumes that all the elements in the tree being built are new.
2263
This doesn't add anything to a branch.
2265
:type shape: list or tuple.
2266
:param line_endings: Either 'binary' or 'native'
2267
in binary mode, exact contents are written in native mode, the
2268
line endings match the default platform endings.
2269
:param transport: A transport to write to, for building trees on VFS's.
2270
If the transport is readonly or None, "." is opened automatically.
2273
if type(shape) not in (list, tuple):
2274
raise AssertionError("Parameter 'shape' should be "
2275
"a list or a tuple. Got %r instead" % (shape,))
2276
# It's OK to just create them using forward slashes on windows.
2277
if transport is None or transport.is_readonly():
2278
transport = get_transport(".")
2280
self.assertIsInstance(name, basestring)
2282
transport.mkdir(urlutils.escape(name[:-1]))
2284
if line_endings == 'binary':
2286
elif line_endings == 'native':
2289
raise errors.BzrError(
2290
'Invalid line ending request %r' % line_endings)
2291
content = "contents of %s%s" % (name.encode('utf-8'), end)
2292
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2294
def build_tree_contents(self, shape):
2295
build_tree_contents(shape)
2297
def assertInWorkingTree(self, path, root_path='.', tree=None):
2298
"""Assert whether path or paths are in the WorkingTree"""
2300
tree = workingtree.WorkingTree.open(root_path)
2301
if not isinstance(path, basestring):
2303
self.assertInWorkingTree(p, tree=tree)
2305
self.assertIsNot(tree.path2id(path), None,
2306
path+' not in working tree.')
2308
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2309
"""Assert whether path or paths are not in the WorkingTree"""
2311
tree = workingtree.WorkingTree.open(root_path)
2312
if not isinstance(path, basestring):
2314
self.assertNotInWorkingTree(p,tree=tree)
2316
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2319
class TestCaseWithTransport(TestCaseInTempDir):
2320
"""A test case that provides get_url and get_readonly_url facilities.
2322
These back onto two transport servers, one for readonly access and one for
2325
If no explicit class is provided for readonly access, a
2326
ReadonlyTransportDecorator is used instead which allows the use of non disk
2327
based read write transports.
2329
If an explicit class is provided for readonly access, that server and the
2330
readwrite one must both define get_url() as resolving to os.getcwd().
2333
def get_vfs_only_server(self):
2334
"""See TestCaseWithMemoryTransport.
2336
This is useful for some tests with specific servers that need
2339
if self.__vfs_server is None:
2340
self.__vfs_server = self.vfs_transport_factory()
2341
self.__vfs_server.setUp()
2342
self.addCleanup(self.__vfs_server.tearDown)
2343
return self.__vfs_server
2345
def make_branch_and_tree(self, relpath, format=None):
2346
"""Create a branch on the transport and a tree locally.
2348
If the transport is not a LocalTransport, the Tree can't be created on
2349
the transport. In that case if the vfs_transport_factory is
2350
LocalURLServer the working tree is created in the local
2351
directory backing the transport, and the returned tree's branch and
2352
repository will also be accessed locally. Otherwise a lightweight
2353
checkout is created and returned.
2355
:param format: The BzrDirFormat.
2356
:returns: the WorkingTree.
2358
# TODO: always use the local disk path for the working tree,
2359
# this obviously requires a format that supports branch references
2360
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2362
b = self.make_branch(relpath, format=format)
2364
return b.bzrdir.create_workingtree()
2365
except errors.NotLocalUrl:
2366
# We can only make working trees locally at the moment. If the
2367
# transport can't support them, then we keep the non-disk-backed
2368
# branch and create a local checkout.
2369
if self.vfs_transport_factory is LocalURLServer:
2370
# the branch is colocated on disk, we cannot create a checkout.
2371
# hopefully callers will expect this.
2372
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2373
wt = local_controldir.create_workingtree()
2374
if wt.branch._format != b._format:
2376
# Make sure that assigning to wt._branch fixes wt.branch,
2377
# in case the implementation details of workingtree objects
2379
self.assertIs(b, wt.branch)
2382
return b.create_checkout(relpath, lightweight=True)
2384
def assertIsDirectory(self, relpath, transport):
2385
"""Assert that relpath within transport is a directory.
2387
This may not be possible on all transports; in that case it propagates
2388
a TransportNotPossible.
2391
mode = transport.stat(relpath).st_mode
2392
except errors.NoSuchFile:
2393
self.fail("path %s is not a directory; no such file"
2395
if not stat.S_ISDIR(mode):
2396
self.fail("path %s is not a directory; has mode %#o"
2399
def assertTreesEqual(self, left, right):
2400
"""Check that left and right have the same content and properties."""
2401
# we use a tree delta to check for equality of the content, and we
2402
# manually check for equality of other things such as the parents list.
2403
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2404
differences = left.changes_from(right)
2405
self.assertFalse(differences.has_changed(),
2406
"Trees %r and %r are different: %r" % (left, right, differences))
2409
super(TestCaseWithTransport, self).setUp()
2410
self.__vfs_server = None
2413
class ChrootedTestCase(TestCaseWithTransport):
2414
"""A support class that provides readonly urls outside the local namespace.
2416
This is done by checking if self.transport_server is a MemoryServer. if it
2417
is then we are chrooted already, if it is not then an HttpServer is used
2420
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2421
be used without needed to redo it when a different
2422
subclass is in use ?
2426
super(ChrootedTestCase, self).setUp()
2427
if not self.vfs_transport_factory == MemoryServer:
2428
self.transport_readonly_server = HttpServer
2431
def condition_id_re(pattern):
2432
"""Create a condition filter which performs a re check on a test's id.
2434
:param pattern: A regular expression string.
2435
:return: A callable that returns True if the re matches.
2437
filter_re = osutils.re_compile_checked(pattern, 0,
2439
def condition(test):
2441
return filter_re.search(test_id)
2445
def condition_isinstance(klass_or_klass_list):
2446
"""Create a condition filter which returns isinstance(param, klass).
2448
:return: A callable which when called with one parameter obj return the
2449
result of isinstance(obj, klass_or_klass_list).
2452
return isinstance(obj, klass_or_klass_list)
2456
def condition_id_in_list(id_list):
2457
"""Create a condition filter which verify that test's id in a list.
2459
:param id_list: A TestIdList object.
2460
:return: A callable that returns True if the test's id appears in the list.
2462
def condition(test):
2463
return id_list.includes(test.id())
2467
def condition_id_startswith(starts):
2468
"""Create a condition filter verifying that test's id starts with a string.
2470
:param starts: A list of string.
2471
:return: A callable that returns True if the test's id starts with one of
2474
def condition(test):
2475
for start in starts:
2476
if test.id().startswith(start):
2482
def exclude_tests_by_condition(suite, condition):
2483
"""Create a test suite which excludes some tests from suite.
2485
:param suite: The suite to get tests from.
2486
:param condition: A callable whose result evaluates True when called with a
2487
test case which should be excluded from the result.
2488
:return: A suite which contains the tests found in suite that fail
2492
for test in iter_suite_tests(suite):
2493
if not condition(test):
2495
return TestUtil.TestSuite(result)
2498
def filter_suite_by_condition(suite, condition):
2499
"""Create a test suite by filtering another one.
2501
:param suite: The source suite.
2502
:param condition: A callable whose result evaluates True when called with a
2503
test case which should be included in the result.
2504
:return: A suite which contains the tests found in suite that pass
2508
for test in iter_suite_tests(suite):
2511
return TestUtil.TestSuite(result)
2514
def filter_suite_by_re(suite, pattern):
2515
"""Create a test suite by filtering another one.
2517
:param suite: the source suite
2518
:param pattern: pattern that names must match
2519
:returns: the newly created suite
2521
condition = condition_id_re(pattern)
2522
result_suite = filter_suite_by_condition(suite, condition)
2526
def filter_suite_by_id_list(suite, test_id_list):
2527
"""Create a test suite by filtering another one.
2529
:param suite: The source suite.
2530
:param test_id_list: A list of the test ids to keep as strings.
2531
:returns: the newly created suite
2533
condition = condition_id_in_list(test_id_list)
2534
result_suite = filter_suite_by_condition(suite, condition)
2538
def filter_suite_by_id_startswith(suite, start):
2539
"""Create a test suite by filtering another one.
2541
:param suite: The source suite.
2542
:param start: A list of string the test id must start with one of.
2543
:returns: the newly created suite
2545
condition = condition_id_startswith(start)
2546
result_suite = filter_suite_by_condition(suite, condition)
2550
def exclude_tests_by_re(suite, pattern):
2551
"""Create a test suite which excludes some tests from suite.
2553
:param suite: The suite to get tests from.
2554
:param pattern: A regular expression string. Test ids that match this
2555
pattern will be excluded from the result.
2556
:return: A TestSuite that contains all the tests from suite without the
2557
tests that matched pattern. The order of tests is the same as it was in
2560
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2563
def preserve_input(something):
2564
"""A helper for performing test suite transformation chains.
2566
:param something: Anything you want to preserve.
2572
def randomize_suite(suite):
2573
"""Return a new TestSuite with suite's tests in random order.
2575
The tests in the input suite are flattened into a single suite in order to
2576
accomplish this. Any nested TestSuites are removed to provide global
2579
tests = list(iter_suite_tests(suite))
2580
random.shuffle(tests)
2581
return TestUtil.TestSuite(tests)
2584
def split_suite_by_condition(suite, condition):
2585
"""Split a test suite into two by a condition.
2587
:param suite: The suite to split.
2588
:param condition: The condition to match on. Tests that match this
2589
condition are returned in the first test suite, ones that do not match
2590
are in the second suite.
2591
:return: A tuple of two test suites, where the first contains tests from
2592
suite matching the condition, and the second contains the remainder
2593
from suite. The order within each output suite is the same as it was in
2598
for test in iter_suite_tests(suite):
2600
matched.append(test)
2602
did_not_match.append(test)
2603
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2606
def split_suite_by_re(suite, pattern):
2607
"""Split a test suite into two by a regular expression.
2609
:param suite: The suite to split.
2610
:param pattern: A regular expression string. Test ids that match this
2611
pattern will be in the first test suite returned, and the others in the
2612
second test suite returned.
2613
:return: A tuple of two test suites, where the first contains tests from
2614
suite matching pattern, and the second contains the remainder from
2615
suite. The order within each output suite is the same as it was in
2618
return split_suite_by_condition(suite, condition_id_re(pattern))
2621
def run_suite(suite, name='test', verbose=False, pattern=".*",
2622
stop_on_failure=False,
2623
transport=None, lsprof_timed=None, bench_history=None,
2624
matching_tests_first=None,
2627
exclude_pattern=None,
2630
"""Run a test suite for bzr selftest.
2632
:param runner_class: The class of runner to use. Must support the
2633
constructor arguments passed by run_suite which are more than standard
2635
:return: A boolean indicating success.
2637
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2642
if runner_class is None:
2643
runner_class = TextTestRunner
2644
runner = runner_class(stream=sys.stdout,
2646
verbosity=verbosity,
2647
bench_history=bench_history,
2648
list_only=list_only,
2650
runner.stop_on_failure=stop_on_failure
2651
# Initialise the random number generator and display the seed used.
2652
# We convert the seed to a long to make it reuseable across invocations.
2653
random_order = False
2654
if random_seed is not None:
2656
if random_seed == "now":
2657
random_seed = long(time.time())
2659
# Convert the seed to a long if we can
2661
random_seed = long(random_seed)
2664
runner.stream.writeln("Randomizing test order using seed %s\n" %
2666
random.seed(random_seed)
2667
# Customise the list of tests if requested
2668
if exclude_pattern is not None:
2669
suite = exclude_tests_by_re(suite, exclude_pattern)
2671
order_changer = randomize_suite
2673
order_changer = preserve_input
2674
if pattern != '.*' or random_order:
2675
if matching_tests_first:
2676
suites = map(order_changer, split_suite_by_re(suite, pattern))
2677
suite = TestUtil.TestSuite(suites)
2679
suite = order_changer(filter_suite_by_re(suite, pattern))
2681
result = runner.run(suite)
2684
return result.wasStrictlySuccessful()
2686
return result.wasSuccessful()
2689
# Controlled by "bzr selftest -E=..." option
2690
selftest_debug_flags = set()
2693
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2695
test_suite_factory=None,
2698
matching_tests_first=None,
2701
exclude_pattern=None,
2708
"""Run the whole test suite under the enhanced runner"""
2709
# XXX: Very ugly way to do this...
2710
# Disable warning about old formats because we don't want it to disturb
2711
# any blackbox tests.
2712
from bzrlib import repository
2713
repository._deprecation_warning_done = True
2715
global default_transport
2716
if transport is None:
2717
transport = default_transport
2718
old_transport = default_transport
2719
default_transport = transport
2720
global selftest_debug_flags
2721
old_debug_flags = selftest_debug_flags
2722
if debug_flags is not None:
2723
selftest_debug_flags = set(debug_flags)
2725
if load_list is None:
2728
keep_only = load_test_id_list(load_list)
2729
if test_suite_factory is None:
2730
suite = test_suite(keep_only, starting_with)
2732
suite = test_suite_factory()
2733
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2734
stop_on_failure=stop_on_failure,
2735
transport=transport,
2736
lsprof_timed=lsprof_timed,
2737
bench_history=bench_history,
2738
matching_tests_first=matching_tests_first,
2739
list_only=list_only,
2740
random_seed=random_seed,
2741
exclude_pattern=exclude_pattern,
2743
runner_class=runner_class,
2746
default_transport = old_transport
2747
selftest_debug_flags = old_debug_flags
2750
def load_test_id_list(file_name):
2751
"""Load a test id list from a text file.
2753
The format is one test id by line. No special care is taken to impose
2754
strict rules, these test ids are used to filter the test suite so a test id
2755
that do not match an existing test will do no harm. This allows user to add
2756
comments, leave blank lines, etc.
2760
ftest = open(file_name, 'rt')
2762
if e.errno != errno.ENOENT:
2765
raise errors.NoSuchFile(file_name)
2767
for test_name in ftest.readlines():
2768
test_list.append(test_name.strip())
2773
def suite_matches_id_list(test_suite, id_list):
2774
"""Warns about tests not appearing or appearing more than once.
2776
:param test_suite: A TestSuite object.
2777
:param test_id_list: The list of test ids that should be found in
2780
:return: (absents, duplicates) absents is a list containing the test found
2781
in id_list but not in test_suite, duplicates is a list containing the
2782
test found multiple times in test_suite.
2784
When using a prefined test id list, it may occurs that some tests do not
2785
exist anymore or that some tests use the same id. This function warns the
2786
tester about potential problems in his workflow (test lists are volatile)
2787
or in the test suite itself (using the same id for several tests does not
2788
help to localize defects).
2790
# Build a dict counting id occurrences
2792
for test in iter_suite_tests(test_suite):
2794
tests[id] = tests.get(id, 0) + 1
2799
occurs = tests.get(id, 0)
2801
not_found.append(id)
2803
duplicates.append(id)
2805
return not_found, duplicates
2808
class TestIdList(object):
2809
"""Test id list to filter a test suite.
2811
Relying on the assumption that test ids are built as:
2812
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2813
notation, this class offers methods to :
2814
- avoid building a test suite for modules not refered to in the test list,
2815
- keep only the tests listed from the module test suite.
2818
def __init__(self, test_id_list):
2819
# When a test suite needs to be filtered against us we compare test ids
2820
# for equality, so a simple dict offers a quick and simple solution.
2821
self.tests = dict().fromkeys(test_id_list, True)
2823
# While unittest.TestCase have ids like:
2824
# <module>.<class>.<method>[(<param+)],
2825
# doctest.DocTestCase can have ids like:
2828
# <module>.<function>
2829
# <module>.<class>.<method>
2831
# Since we can't predict a test class from its name only, we settle on
2832
# a simple constraint: a test id always begins with its module name.
2835
for test_id in test_id_list:
2836
parts = test_id.split('.')
2837
mod_name = parts.pop(0)
2838
modules[mod_name] = True
2840
mod_name += '.' + part
2841
modules[mod_name] = True
2842
self.modules = modules
2844
def refers_to(self, module_name):
2845
"""Is there tests for the module or one of its sub modules."""
2846
return self.modules.has_key(module_name)
2848
def includes(self, test_id):
2849
return self.tests.has_key(test_id)
2852
class TestPrefixAliasRegistry(registry.Registry):
2853
"""A registry for test prefix aliases.
2855
This helps implement shorcuts for the --starting-with selftest
2856
option. Overriding existing prefixes is not allowed but not fatal (a
2857
warning will be emitted).
2860
def register(self, key, obj, help=None, info=None,
2861
override_existing=False):
2862
"""See Registry.register.
2864
Trying to override an existing alias causes a warning to be emitted,
2865
not a fatal execption.
2868
super(TestPrefixAliasRegistry, self).register(
2869
key, obj, help=help, info=info, override_existing=False)
2871
actual = self.get(key)
2872
note('Test prefix alias %s is already used for %s, ignoring %s'
2873
% (key, actual, obj))
2875
def resolve_alias(self, id_start):
2876
"""Replace the alias by the prefix in the given string.
2878
Using an unknown prefix is an error to help catching typos.
2880
parts = id_start.split('.')
2882
parts[0] = self.get(parts[0])
2884
raise errors.BzrCommandError(
2885
'%s is not a known test prefix alias' % parts[0])
2886
return '.'.join(parts)
2889
test_prefix_alias_registry = TestPrefixAliasRegistry()
2890
"""Registry of test prefix aliases."""
2893
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2894
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2895
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2897
# Obvious higest levels prefixes, feel free to add your own via a plugin
2898
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2899
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2900
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2901
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2902
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2905
def test_suite(keep_only=None, starting_with=None):
2906
"""Build and return TestSuite for the whole of bzrlib.
2908
:param keep_only: A list of test ids limiting the suite returned.
2910
:param starting_with: An id limiting the suite returned to the tests
2913
This function can be replaced if you need to change the default test
2914
suite on a global basis, but it is not encouraged.
2918
'bzrlib.tests.blackbox',
2919
'bzrlib.tests.branch_implementations',
2920
'bzrlib.tests.bzrdir_implementations',
2921
'bzrlib.tests.commands',
2922
'bzrlib.tests.interrepository_implementations',
2923
'bzrlib.tests.intertree_implementations',
2924
'bzrlib.tests.inventory_implementations',
2925
'bzrlib.tests.per_interbranch',
2926
'bzrlib.tests.per_lock',
2927
'bzrlib.tests.per_repository',
2928
'bzrlib.tests.per_repository_reference',
2929
'bzrlib.tests.test__dirstate_helpers',
2930
'bzrlib.tests.test__walkdirs_win32',
2931
'bzrlib.tests.test_ancestry',
2932
'bzrlib.tests.test_annotate',
2933
'bzrlib.tests.test_api',
2934
'bzrlib.tests.test_atomicfile',
2935
'bzrlib.tests.test_bad_files',
2936
'bzrlib.tests.test_bisect_multi',
2937
'bzrlib.tests.test_branch',
2938
'bzrlib.tests.test_branchbuilder',
2939
'bzrlib.tests.test_btree_index',
2940
'bzrlib.tests.test_bugtracker',
2941
'bzrlib.tests.test_bundle',
2942
'bzrlib.tests.test_bzrdir',
2943
'bzrlib.tests.test_cache_utf8',
2944
'bzrlib.tests.test_clean_tree',
2945
'bzrlib.tests.test_chunk_writer',
2946
'bzrlib.tests.test__chunks_to_lines',
2947
'bzrlib.tests.test_commands',
2948
'bzrlib.tests.test_commit',
2949
'bzrlib.tests.test_commit_merge',
2950
'bzrlib.tests.test_config',
2951
'bzrlib.tests.test_conflicts',
2952
'bzrlib.tests.test_counted_lock',
2953
'bzrlib.tests.test_decorators',
2954
'bzrlib.tests.test_delta',
2955
'bzrlib.tests.test_debug',
2956
'bzrlib.tests.test_deprecated_graph',
2957
'bzrlib.tests.test_diff',
2958
'bzrlib.tests.test_directory_service',
2959
'bzrlib.tests.test_dirstate',
2960
'bzrlib.tests.test_email_message',
2961
'bzrlib.tests.test_errors',
2962
'bzrlib.tests.test_export',
2963
'bzrlib.tests.test_extract',
2964
'bzrlib.tests.test_fetch',
2965
'bzrlib.tests.test_fifo_cache',
2966
'bzrlib.tests.test_filters',
2967
'bzrlib.tests.test_ftp_transport',
2968
'bzrlib.tests.test_foreign',
2969
'bzrlib.tests.test_generate_docs',
2970
'bzrlib.tests.test_generate_ids',
2971
'bzrlib.tests.test_globbing',
2972
'bzrlib.tests.test_gpg',
2973
'bzrlib.tests.test_graph',
2974
'bzrlib.tests.test_hashcache',
2975
'bzrlib.tests.test_help',
2976
'bzrlib.tests.test_hooks',
2977
'bzrlib.tests.test_http',
2978
'bzrlib.tests.test_http_implementations',
2979
'bzrlib.tests.test_http_response',
2980
'bzrlib.tests.test_https_ca_bundle',
2981
'bzrlib.tests.test_identitymap',
2982
'bzrlib.tests.test_ignores',
2983
'bzrlib.tests.test_index',
2984
'bzrlib.tests.test_info',
2985
'bzrlib.tests.test_inv',
2986
'bzrlib.tests.test_knit',
2987
'bzrlib.tests.test_lazy_import',
2988
'bzrlib.tests.test_lazy_regex',
2989
'bzrlib.tests.test_lockable_files',
2990
'bzrlib.tests.test_lockdir',
2991
'bzrlib.tests.test_log',
2992
'bzrlib.tests.test_lru_cache',
2993
'bzrlib.tests.test_lsprof',
2994
'bzrlib.tests.test_mail_client',
2995
'bzrlib.tests.test_memorytree',
2996
'bzrlib.tests.test_merge',
2997
'bzrlib.tests.test_merge3',
2998
'bzrlib.tests.test_merge_core',
2999
'bzrlib.tests.test_merge_directive',
3000
'bzrlib.tests.test_missing',
3001
'bzrlib.tests.test_msgeditor',
3002
'bzrlib.tests.test_multiparent',
3003
'bzrlib.tests.test_mutabletree',
3004
'bzrlib.tests.test_nonascii',
3005
'bzrlib.tests.test_options',
3006
'bzrlib.tests.test_osutils',
3007
'bzrlib.tests.test_osutils_encodings',
3008
'bzrlib.tests.test_pack',
3009
'bzrlib.tests.test_pack_repository',
3010
'bzrlib.tests.test_patch',
3011
'bzrlib.tests.test_patches',
3012
'bzrlib.tests.test_permissions',
3013
'bzrlib.tests.test_plugins',
3014
'bzrlib.tests.test_progress',
3015
'bzrlib.tests.test_read_bundle',
3016
'bzrlib.tests.test_reconcile',
3017
'bzrlib.tests.test_reconfigure',
3018
'bzrlib.tests.test_registry',
3019
'bzrlib.tests.test_remote',
3020
'bzrlib.tests.test_repository',
3021
'bzrlib.tests.test_revert',
3022
'bzrlib.tests.test_revision',
3023
'bzrlib.tests.test_revisionspec',
3024
'bzrlib.tests.test_revisiontree',
3025
'bzrlib.tests.test_rio',
3026
'bzrlib.tests.test_rules',
3027
'bzrlib.tests.test_sampler',
3028
'bzrlib.tests.test_selftest',
3029
'bzrlib.tests.test_setup',
3030
'bzrlib.tests.test_sftp_transport',
3031
'bzrlib.tests.test_shelf',
3032
'bzrlib.tests.test_shelf_ui',
3033
'bzrlib.tests.test_smart',
3034
'bzrlib.tests.test_smart_add',
3035
'bzrlib.tests.test_smart_request',
3036
'bzrlib.tests.test_smart_transport',
3037
'bzrlib.tests.test_smtp_connection',
3038
'bzrlib.tests.test_source',
3039
'bzrlib.tests.test_ssh_transport',
3040
'bzrlib.tests.test_status',
3041
'bzrlib.tests.test_store',
3042
'bzrlib.tests.test_strace',
3043
'bzrlib.tests.test_subsume',
3044
'bzrlib.tests.test_switch',
3045
'bzrlib.tests.test_symbol_versioning',
3046
'bzrlib.tests.test_tag',
3047
'bzrlib.tests.test_testament',
3048
'bzrlib.tests.test_textfile',
3049
'bzrlib.tests.test_textmerge',
3050
'bzrlib.tests.test_timestamp',
3051
'bzrlib.tests.test_trace',
3052
'bzrlib.tests.test_transactions',
3053
'bzrlib.tests.test_transform',
3054
'bzrlib.tests.test_transport',
3055
'bzrlib.tests.test_transport_implementations',
3056
'bzrlib.tests.test_transport_log',
3057
'bzrlib.tests.test_tree',
3058
'bzrlib.tests.test_treebuilder',
3059
'bzrlib.tests.test_tsort',
3060
'bzrlib.tests.test_tuned_gzip',
3061
'bzrlib.tests.test_ui',
3062
'bzrlib.tests.test_uncommit',
3063
'bzrlib.tests.test_upgrade',
3064
'bzrlib.tests.test_upgrade_stacked',
3065
'bzrlib.tests.test_urlutils',
3066
'bzrlib.tests.test_version',
3067
'bzrlib.tests.test_version_info',
3068
'bzrlib.tests.test_versionedfile',
3069
'bzrlib.tests.test_weave',
3070
'bzrlib.tests.test_whitebox',
3071
'bzrlib.tests.test_win32utils',
3072
'bzrlib.tests.test_workingtree',
3073
'bzrlib.tests.test_workingtree_4',
3074
'bzrlib.tests.test_wsgi',
3075
'bzrlib.tests.test_xml',
3076
'bzrlib.tests.tree_implementations',
3077
'bzrlib.tests.workingtree_implementations',
3078
'bzrlib.util.tests.test_bencode',
3081
loader = TestUtil.TestLoader()
3084
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3085
for start in starting_with]
3086
# We take precedence over keep_only because *at loading time* using
3087
# both options means we will load less tests for the same final result.
3088
def interesting_module(name):
3089
for start in starting_with:
3091
# Either the module name starts with the specified string
3092
name.startswith(start)
3093
# or it may contain tests starting with the specified string
3094
or start.startswith(name)
3098
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3100
elif keep_only is not None:
3101
id_filter = TestIdList(keep_only)
3102
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3103
def interesting_module(name):
3104
return id_filter.refers_to(name)
3107
loader = TestUtil.TestLoader()
3108
def interesting_module(name):
3109
# No filtering, all modules are interesting
3112
suite = loader.suiteClass()
3114
# modules building their suite with loadTestsFromModuleNames
3115
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3117
modules_to_doctest = [
3119
'bzrlib.branchbuilder',
3122
'bzrlib.iterablefile',
3126
'bzrlib.symbol_versioning',
3129
'bzrlib.version_info_formats.format_custom',
3132
for mod in modules_to_doctest:
3133
if not interesting_module(mod):
3134
# No tests to keep here, move along
3137
# note that this really does mean "report only" -- doctest
3138
# still runs the rest of the examples
3139
doc_suite = doctest.DocTestSuite(mod,
3140
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3141
except ValueError, e:
3142
print '**failed to get doctest for: %s\n%s' % (mod, e)
3144
if len(doc_suite._tests) == 0:
3145
raise errors.BzrError("no doctests found in %s" % (mod,))
3146
suite.addTest(doc_suite)
3148
default_encoding = sys.getdefaultencoding()
3149
for name, plugin in bzrlib.plugin.plugins().items():
3150
if not interesting_module(plugin.module.__name__):
3152
plugin_suite = plugin.test_suite()
3153
# We used to catch ImportError here and turn it into just a warning,
3154
# but really if you don't have --no-plugins this should be a failure.
3155
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3156
if plugin_suite is None:
3157
plugin_suite = plugin.load_plugin_tests(loader)
3158
if plugin_suite is not None:
3159
suite.addTest(plugin_suite)
3160
if default_encoding != sys.getdefaultencoding():
3161
bzrlib.trace.warning(
3162
'Plugin "%s" tried to reset default encoding to: %s', name,
3163
sys.getdefaultencoding())
3165
sys.setdefaultencoding(default_encoding)
3168
suite = filter_suite_by_id_startswith(suite, starting_with)
3170
if keep_only is not None:
3171
# Now that the referred modules have loaded their tests, keep only the
3173
suite = filter_suite_by_id_list(suite, id_filter)
3174
# Do some sanity checks on the id_list filtering
3175
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3177
# The tester has used both keep_only and starting_with, so he is
3178
# already aware that some tests are excluded from the list, there
3179
# is no need to tell him which.
3182
# Some tests mentioned in the list are not in the test suite. The
3183
# list may be out of date, report to the tester.
3184
for id in not_found:
3185
bzrlib.trace.warning('"%s" not found in the test suite', id)
3186
for id in duplicates:
3187
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3192
def multiply_scenarios(scenarios_left, scenarios_right):
3193
"""Multiply two sets of scenarios.
3195
:returns: the cartesian product of the two sets of scenarios, that is
3196
a scenario for every possible combination of a left scenario and a
3200
('%s,%s' % (left_name, right_name),
3201
dict(left_dict.items() + right_dict.items()))
3202
for left_name, left_dict in scenarios_left
3203
for right_name, right_dict in scenarios_right]
3206
def multiply_tests(tests, scenarios, result):
3207
"""Multiply tests_list by scenarios into result.
3209
This is the core workhorse for test parameterisation.
3211
Typically the load_tests() method for a per-implementation test suite will
3212
call multiply_tests and return the result.
3214
:param tests: The tests to parameterise.
3215
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3216
scenario_param_dict).
3217
:param result: A TestSuite to add created tests to.
3219
This returns the passed in result TestSuite with the cross product of all
3220
the tests repeated once for each scenario. Each test is adapted by adding
3221
the scenario name at the end of its id(), and updating the test object's
3222
__dict__ with the scenario_param_dict.
3224
>>> r = multiply_tests(
3225
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3226
... [('one', dict(param=1)),
3227
... ('two', dict(param=2))],
3229
>>> tests = list(iter_suite_tests(r))
3233
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3239
for test in iter_suite_tests(tests):
3240
apply_scenarios(test, scenarios, result)
3244
def apply_scenarios(test, scenarios, result):
3245
"""Apply the scenarios in scenarios to test and add to result.
3247
:param test: The test to apply scenarios to.
3248
:param scenarios: An iterable of scenarios to apply to test.
3250
:seealso: apply_scenario
3252
for scenario in scenarios:
3253
result.addTest(apply_scenario(test, scenario))
3257
def apply_scenario(test, scenario):
3258
"""Copy test and apply scenario to it.
3260
:param test: A test to adapt.
3261
:param scenario: A tuple describing the scenarion.
3262
The first element of the tuple is the new test id.
3263
The second element is a dict containing attributes to set on the
3265
:return: The adapted test.
3267
new_id = "%s(%s)" % (test.id(), scenario[0])
3268
new_test = clone_test(test, new_id)
3269
for name, value in scenario[1].items():
3270
setattr(new_test, name, value)
3274
def clone_test(test, new_id):
3275
"""Clone a test giving it a new id.
3277
:param test: The test to clone.
3278
:param new_id: The id to assign to it.
3279
:return: The new test.
3281
from copy import deepcopy
3282
new_test = deepcopy(test)
3283
new_test.id = lambda: new_id
3287
def _rmtree_temp_dir(dirname):
3288
# If LANG=C we probably have created some bogus paths
3289
# which rmtree(unicode) will fail to delete
3290
# so make sure we are using rmtree(str) to delete everything
3291
# except on win32, where rmtree(str) will fail
3292
# since it doesn't have the property of byte-stream paths
3293
# (they are either ascii or mbcs)
3294
if sys.platform == 'win32':
3295
# make sure we are using the unicode win32 api
3296
dirname = unicode(dirname)
3298
dirname = dirname.encode(sys.getfilesystemencoding())
3300
osutils.rmtree(dirname)
3302
if sys.platform == 'win32' and e.errno == errno.EACCES:
3303
sys.stderr.write(('Permission denied: '
3304
'unable to remove testing dir '
3305
'%s\n' % os.path.basename(dirname)))
3310
class Feature(object):
3311
"""An operating system Feature."""
3314
self._available = None
3316
def available(self):
3317
"""Is the feature available?
3319
:return: True if the feature is available.
3321
if self._available is None:
3322
self._available = self._probe()
3323
return self._available
3326
"""Implement this method in concrete features.
3328
:return: True if the feature is available.
3330
raise NotImplementedError
3333
if getattr(self, 'feature_name', None):
3334
return self.feature_name()
3335
return self.__class__.__name__
3338
class _SymlinkFeature(Feature):
3341
return osutils.has_symlinks()
3343
def feature_name(self):
3346
SymlinkFeature = _SymlinkFeature()
3349
class _HardlinkFeature(Feature):
3352
return osutils.has_hardlinks()
3354
def feature_name(self):
3357
HardlinkFeature = _HardlinkFeature()
3360
class _OsFifoFeature(Feature):
3363
return getattr(os, 'mkfifo', None)
3365
def feature_name(self):
3366
return 'filesystem fifos'
3368
OsFifoFeature = _OsFifoFeature()
3371
class _UnicodeFilenameFeature(Feature):
3372
"""Does the filesystem support Unicode filenames?"""
3376
# Check for character combinations unlikely to be covered by any
3377
# single non-unicode encoding. We use the characters
3378
# - greek small letter alpha (U+03B1) and
3379
# - braille pattern dots-123456 (U+283F).
3380
os.stat(u'\u03b1\u283f')
3381
except UnicodeEncodeError:
3383
except (IOError, OSError):
3384
# The filesystem allows the Unicode filename but the file doesn't
3388
# The filesystem allows the Unicode filename and the file exists,
3392
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3395
def probe_unicode_in_user_encoding():
3396
"""Try to encode several unicode strings to use in unicode-aware tests.
3397
Return first successfull match.
3399
:return: (unicode value, encoded plain string value) or (None, None)
3401
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3402
for uni_val in possible_vals:
3404
str_val = uni_val.encode(osutils.get_user_encoding())
3405
except UnicodeEncodeError:
3406
# Try a different character
3409
return uni_val, str_val
3413
def probe_bad_non_ascii(encoding):
3414
"""Try to find [bad] character with code [128..255]
3415
that cannot be decoded to unicode in some encoding.
3416
Return None if all non-ascii characters is valid
3419
for i in xrange(128, 256):
3422
char.decode(encoding)
3423
except UnicodeDecodeError:
3428
class _HTTPSServerFeature(Feature):
3429
"""Some tests want an https Server, check if one is available.
3431
Right now, the only way this is available is under python2.6 which provides
3442
def feature_name(self):
3443
return 'HTTPSServer'
3446
HTTPSServerFeature = _HTTPSServerFeature()
3449
class _UnicodeFilename(Feature):
3450
"""Does the filesystem support Unicode filenames?"""
3455
except UnicodeEncodeError:
3457
except (IOError, OSError):
3458
# The filesystem allows the Unicode filename but the file doesn't
3462
# The filesystem allows the Unicode filename and the file exists,
3466
UnicodeFilename = _UnicodeFilename()
3469
class _UTF8Filesystem(Feature):
3470
"""Is the filesystem UTF-8?"""
3473
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3477
UTF8Filesystem = _UTF8Filesystem()
3480
class _CaseInsCasePresFilenameFeature(Feature):
3481
"""Is the file-system case insensitive, but case-preserving?"""
3484
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3486
# first check truly case-preserving for created files, then check
3487
# case insensitive when opening existing files.
3488
name = osutils.normpath(name)
3489
base, rel = osutils.split(name)
3490
found_rel = osutils.canonical_relpath(base, name)
3491
return (found_rel == rel
3492
and os.path.isfile(name.upper())
3493
and os.path.isfile(name.lower()))
3498
def feature_name(self):
3499
return "case-insensitive case-preserving filesystem"
3501
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3504
class _CaseInsensitiveFilesystemFeature(Feature):
3505
"""Check if underlying filesystem is case-insensitive but *not* case
3508
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3509
# more likely to be case preserving, so this case is rare.
3512
if CaseInsCasePresFilenameFeature.available():
3515
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3516
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3517
TestCaseWithMemoryTransport.TEST_ROOT = root
3519
root = TestCaseWithMemoryTransport.TEST_ROOT
3520
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3522
name_a = osutils.pathjoin(tdir, 'a')
3523
name_A = osutils.pathjoin(tdir, 'A')
3525
result = osutils.isdir(name_A)
3526
_rmtree_temp_dir(tdir)
3529
def feature_name(self):
3530
return 'case-insensitive filesystem'
3532
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3535
class _SubUnitFeature(Feature):
3536
"""Check if subunit is available."""
3545
def feature_name(self):
3548
SubUnitFeature = _SubUnitFeature()
3549
# Only define SubUnitBzrRunner if subunit is available.
3551
from subunit import TestProtocolClient
3552
class SubUnitBzrRunner(TextTestRunner):
3553
def run(self, test):
3554
# undo out claim for testing which looks like a test start to subunit
3555
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3556
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
