1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
66
import bzrlib.commands
67
import bzrlib.timestamp
69
import bzrlib.inventory
70
import bzrlib.iterablefile
75
# lsprof not available
77
from bzrlib.merge import merge_inner
80
from bzrlib.smart import client, server
82
from bzrlib import symbol_versioning
83
from bzrlib.symbol_versioning import (
90
from bzrlib.transport import get_transport
91
import bzrlib.transport
92
from bzrlib.transport.local import LocalURLServer
93
from bzrlib.transport.memory import MemoryServer
94
from bzrlib.transport.readonly import ReadonlyServer
95
from bzrlib.trace import mutter, note
96
from bzrlib.tests import TestUtil
97
from bzrlib.tests.http_server import HttpServer
98
from bzrlib.tests.TestUtil import (
102
from bzrlib.tests.treeshape import build_tree_contents
103
import bzrlib.version_info_formats.format_custom
104
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
106
# Mark this python module as being part of the implementation
107
# of unittest: this gives us better tracebacks where the last
108
# shown frame is the test code, not our assertXYZ.
111
default_transport = LocalURLServer
114
class ExtendedTestResult(unittest._TextTestResult):
115
"""Accepts, reports and accumulates the results of running tests.
117
Compared to the unittest version this class adds support for
118
profiling, benchmarking, stopping as soon as a test fails, and
119
skipping tests. There are further-specialized subclasses for
120
different types of display.
122
When a test finishes, in whatever way, it calls one of the addSuccess,
123
addFailure or addError classes. These in turn may redirect to a more
124
specific case for the special test results supported by our extended
127
Note that just one of these objects is fed the results from many tests.
132
def __init__(self, stream, descriptions, verbosity,
136
"""Construct new TestResult.
138
:param bench_history: Optionally, a writable file object to accumulate
141
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
142
if bench_history is not None:
143
from bzrlib.version import _get_bzr_source_tree
144
src_tree = _get_bzr_source_tree()
147
revision_id = src_tree.get_parent_ids()[0]
149
# XXX: if this is a brand new tree, do the same as if there
153
# XXX: If there's no branch, what should we do?
155
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
156
self._bench_history = bench_history
157
self.ui = ui.ui_factory
158
self.num_tests = num_tests
160
self.failure_count = 0
161
self.known_failure_count = 0
163
self.not_applicable_count = 0
164
self.unsupported = {}
166
self._overall_start_time = time.time()
168
def _extractBenchmarkTime(self, testCase):
169
"""Add a benchmark time for the current test case."""
170
return getattr(testCase, "_benchtime", None)
172
def _elapsedTestTimeString(self):
173
"""Return a time string for the overall time the current test has taken."""
174
return self._formatTime(time.time() - self._start_time)
176
def _testTimeString(self, testCase):
177
benchmark_time = self._extractBenchmarkTime(testCase)
178
if benchmark_time is not None:
180
self._formatTime(benchmark_time),
181
self._elapsedTestTimeString())
183
return " %s" % self._elapsedTestTimeString()
185
def _formatTime(self, seconds):
186
"""Format seconds as milliseconds with leading spaces."""
187
# some benchmarks can take thousands of seconds to run, so we need 8
189
return "%8dms" % (1000 * seconds)
191
def _shortened_test_description(self, test):
193
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
196
def startTest(self, test):
197
unittest.TestResult.startTest(self, test)
198
self.report_test_start(test)
199
test.number = self.count
200
self._recordTestStartTime()
202
def _recordTestStartTime(self):
203
"""Record that a test has started."""
204
self._start_time = time.time()
206
def _cleanupLogFile(self, test):
207
# We can only do this if we have one of our TestCases, not if
209
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
210
if setKeepLogfile is not None:
213
def addError(self, test, err):
214
"""Tell result that test finished with an error.
216
Called from the TestCase run() method when the test
217
fails with an unexpected error.
219
self._testConcluded(test)
220
if isinstance(err[1], TestNotApplicable):
221
return self._addNotApplicable(test, err)
222
elif isinstance(err[1], UnavailableFeature):
223
return self.addNotSupported(test, err[1].args[0])
225
unittest.TestResult.addError(self, test, err)
226
self.error_count += 1
227
self.report_error(test, err)
230
self._cleanupLogFile(test)
232
def addFailure(self, test, err):
233
"""Tell result that test failed.
235
Called from the TestCase run() method when the test
236
fails because e.g. an assert() method failed.
238
self._testConcluded(test)
239
if isinstance(err[1], KnownFailure):
240
return self._addKnownFailure(test, err)
242
unittest.TestResult.addFailure(self, test, err)
243
self.failure_count += 1
244
self.report_failure(test, err)
247
self._cleanupLogFile(test)
249
def addSuccess(self, test):
250
"""Tell result that test completed successfully.
252
Called from the TestCase run()
254
self._testConcluded(test)
255
if self._bench_history is not None:
256
benchmark_time = self._extractBenchmarkTime(test)
257
if benchmark_time is not None:
258
self._bench_history.write("%s %s\n" % (
259
self._formatTime(benchmark_time),
261
self.report_success(test)
262
self._cleanupLogFile(test)
263
unittest.TestResult.addSuccess(self, test)
264
test._log_contents = ''
266
def _testConcluded(self, test):
267
"""Common code when a test has finished.
269
Called regardless of whether it succeded, failed, etc.
273
def _addKnownFailure(self, test, err):
274
self.known_failure_count += 1
275
self.report_known_failure(test, err)
277
def addNotSupported(self, test, feature):
278
"""The test will not be run because of a missing feature.
280
# this can be called in two different ways: it may be that the
281
# test started running, and then raised (through addError)
282
# UnavailableFeature. Alternatively this method can be called
283
# while probing for features before running the tests; in that
284
# case we will see startTest and stopTest, but the test will never
286
self.unsupported.setdefault(str(feature), 0)
287
self.unsupported[str(feature)] += 1
288
self.report_unsupported(test, feature)
290
def addSkip(self, test, reason):
291
"""A test has not run for 'reason'."""
293
self.report_skip(test, reason)
295
def _addNotApplicable(self, test, skip_excinfo):
296
if isinstance(skip_excinfo[1], TestNotApplicable):
297
self.not_applicable_count += 1
298
self.report_not_applicable(test, skip_excinfo)
301
except KeyboardInterrupt:
304
self.addError(test, test.exc_info())
306
# seems best to treat this as success from point-of-view of unittest
307
# -- it actually does nothing so it barely matters :)
308
unittest.TestResult.addSuccess(self, test)
309
test._log_contents = ''
311
def printErrorList(self, flavour, errors):
312
for test, err in errors:
313
self.stream.writeln(self.separator1)
314
self.stream.write("%s: " % flavour)
315
self.stream.writeln(self.getDescription(test))
316
if getattr(test, '_get_log', None) is not None:
317
self.stream.write('\n')
319
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
321
self.stream.write(test._get_log())
322
self.stream.write('\n')
324
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
325
self.stream.write('\n')
326
self.stream.writeln(self.separator2)
327
self.stream.writeln("%s" % err)
332
def report_cleaning_up(self):
335
def report_success(self, test):
338
def wasStrictlySuccessful(self):
339
if self.unsupported or self.known_failure_count:
341
return self.wasSuccessful()
344
class TextTestResult(ExtendedTestResult):
345
"""Displays progress and results of tests in text form"""
347
def __init__(self, stream, descriptions, verbosity,
352
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
353
bench_history, num_tests)
355
self.pb = self.ui.nested_progress_bar()
356
self._supplied_pb = False
359
self._supplied_pb = True
360
self.pb.show_pct = False
361
self.pb.show_spinner = False
362
self.pb.show_eta = False,
363
self.pb.show_count = False
364
self.pb.show_bar = False
366
def report_starting(self):
367
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
369
def _progress_prefix_text(self):
370
# the longer this text, the less space we have to show the test
372
a = '[%d' % self.count # total that have been run
373
# tests skipped as known not to be relevant are not important enough
375
## if self.skip_count:
376
## a += ', %d skip' % self.skip_count
377
## if self.known_failure_count:
378
## a += '+%dX' % self.known_failure_count
379
if self.num_tests is not None:
380
a +='/%d' % self.num_tests
382
runtime = time.time() - self._overall_start_time
384
a += '%dm%ds' % (runtime / 60, runtime % 60)
388
a += ', %d err' % self.error_count
389
if self.failure_count:
390
a += ', %d fail' % self.failure_count
392
a += ', %d missing' % len(self.unsupported)
396
def report_test_start(self, test):
399
self._progress_prefix_text()
401
+ self._shortened_test_description(test))
403
def _test_description(self, test):
404
return self._shortened_test_description(test)
406
def report_error(self, test, err):
407
self.pb.note('ERROR: %s\n %s\n',
408
self._test_description(test),
412
def report_failure(self, test, err):
413
self.pb.note('FAIL: %s\n %s\n',
414
self._test_description(test),
418
def report_known_failure(self, test, err):
419
self.pb.note('XFAIL: %s\n%s\n',
420
self._test_description(test), err[1])
422
def report_skip(self, test, reason):
425
def report_not_applicable(self, test, skip_excinfo):
428
def report_unsupported(self, test, feature):
429
"""test cannot be run because feature is missing."""
431
def report_cleaning_up(self):
432
self.pb.update('Cleaning up')
435
if not self._supplied_pb:
439
class VerboseTestResult(ExtendedTestResult):
440
"""Produce long output, with one line per test run plus times"""
442
def _ellipsize_to_right(self, a_string, final_width):
443
"""Truncate and pad a string, keeping the right hand side"""
444
if len(a_string) > final_width:
445
result = '...' + a_string[3-final_width:]
448
return result.ljust(final_width)
450
def report_starting(self):
451
self.stream.write('running %d tests...\n' % self.num_tests)
453
def report_test_start(self, test):
455
name = self._shortened_test_description(test)
456
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
457
# numbers, plus a trailing blank
458
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
459
self.stream.write(self._ellipsize_to_right(name,
460
osutils.terminal_width()-30))
463
def _error_summary(self, err):
465
return '%s%s' % (indent, err[1])
467
def report_error(self, test, err):
468
self.stream.writeln('ERROR %s\n%s'
469
% (self._testTimeString(test),
470
self._error_summary(err)))
472
def report_failure(self, test, err):
473
self.stream.writeln(' FAIL %s\n%s'
474
% (self._testTimeString(test),
475
self._error_summary(err)))
477
def report_known_failure(self, test, err):
478
self.stream.writeln('XFAIL %s\n%s'
479
% (self._testTimeString(test),
480
self._error_summary(err)))
482
def report_success(self, test):
483
self.stream.writeln(' OK %s' % self._testTimeString(test))
484
for bench_called, stats in getattr(test, '_benchcalls', []):
485
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
486
stats.pprint(file=self.stream)
487
# flush the stream so that we get smooth output. This verbose mode is
488
# used to show the output in PQM.
491
def report_skip(self, test, reason):
492
self.stream.writeln(' SKIP %s\n%s'
493
% (self._testTimeString(test), reason))
495
def report_not_applicable(self, test, skip_excinfo):
496
self.stream.writeln(' N/A %s\n%s'
497
% (self._testTimeString(test),
498
self._error_summary(skip_excinfo)))
500
def report_unsupported(self, test, feature):
501
"""test cannot be run because feature is missing."""
502
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
503
%(self._testTimeString(test), feature))
506
class TextTestRunner(object):
507
stop_on_failure = False
516
self.stream = unittest._WritelnDecorator(stream)
517
self.descriptions = descriptions
518
self.verbosity = verbosity
519
self._bench_history = bench_history
520
self.list_only = list_only
523
"Run the given test case or test suite."
524
startTime = time.time()
525
if self.verbosity == 1:
526
result_class = TextTestResult
527
elif self.verbosity >= 2:
528
result_class = VerboseTestResult
529
result = result_class(self.stream,
532
bench_history=self._bench_history,
533
num_tests=test.countTestCases(),
535
result.stop_early = self.stop_on_failure
536
result.report_starting()
538
if self.verbosity >= 2:
539
self.stream.writeln("Listing tests only ...\n")
541
for t in iter_suite_tests(test):
542
self.stream.writeln("%s" % (t.id()))
544
actionTaken = "Listed"
547
run = result.testsRun
549
stopTime = time.time()
550
timeTaken = stopTime - startTime
552
self.stream.writeln(result.separator2)
553
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
554
run, run != 1 and "s" or "", timeTaken))
555
self.stream.writeln()
556
if not result.wasSuccessful():
557
self.stream.write("FAILED (")
558
failed, errored = map(len, (result.failures, result.errors))
560
self.stream.write("failures=%d" % failed)
562
if failed: self.stream.write(", ")
563
self.stream.write("errors=%d" % errored)
564
if result.known_failure_count:
565
if failed or errored: self.stream.write(", ")
566
self.stream.write("known_failure_count=%d" %
567
result.known_failure_count)
568
self.stream.writeln(")")
570
if result.known_failure_count:
571
self.stream.writeln("OK (known_failures=%d)" %
572
result.known_failure_count)
574
self.stream.writeln("OK")
575
if result.skip_count > 0:
576
skipped = result.skip_count
577
self.stream.writeln('%d test%s skipped' %
578
(skipped, skipped != 1 and "s" or ""))
579
if result.unsupported:
580
for feature, count in sorted(result.unsupported.items()):
581
self.stream.writeln("Missing feature '%s' skipped %d tests." %
587
def iter_suite_tests(suite):
588
"""Return all tests in a suite, recursing through nested suites"""
589
if isinstance(suite, unittest.TestCase):
591
elif isinstance(suite, unittest.TestSuite):
592
for item in suite._tests:
593
for r in iter_suite_tests(item):
596
raise Exception('unknown type %r for object %r'
597
% (type(suite), suite))
600
class TestSkipped(Exception):
601
"""Indicates that a test was intentionally skipped, rather than failing."""
604
class TestNotApplicable(TestSkipped):
605
"""A test is not applicable to the situation where it was run.
607
This is only normally raised by parameterized tests, if they find that
608
the instance they're constructed upon does not support one aspect
613
class KnownFailure(AssertionError):
614
"""Indicates that a test failed in a precisely expected manner.
616
Such failures dont block the whole test suite from passing because they are
617
indicators of partially completed code or of future work. We have an
618
explicit error for them so that we can ensure that they are always visible:
619
KnownFailures are always shown in the output of bzr selftest.
623
class UnavailableFeature(Exception):
624
"""A feature required for this test was not available.
626
The feature should be used to construct the exception.
630
class CommandFailed(Exception):
634
class StringIOWrapper(object):
635
"""A wrapper around cStringIO which just adds an encoding attribute.
637
Internally we can check sys.stdout to see what the output encoding
638
should be. However, cStringIO has no encoding attribute that we can
639
set. So we wrap it instead.
644
def __init__(self, s=None):
646
self.__dict__['_cstring'] = StringIO(s)
648
self.__dict__['_cstring'] = StringIO()
650
def __getattr__(self, name, getattr=getattr):
651
return getattr(self.__dict__['_cstring'], name)
653
def __setattr__(self, name, val):
654
if name == 'encoding':
655
self.__dict__['encoding'] = val
657
return setattr(self._cstring, name, val)
660
class TestUIFactory(ui.CLIUIFactory):
661
"""A UI Factory for testing.
663
Hide the progress bar but emit note()s.
665
Allows get_password to be tested without real tty attached.
672
super(TestUIFactory, self).__init__()
673
if stdin is not None:
674
# We use a StringIOWrapper to be able to test various
675
# encodings, but the user is still responsible to
676
# encode the string and to set the encoding attribute
677
# of StringIOWrapper.
678
self.stdin = StringIOWrapper(stdin)
680
self.stdout = sys.stdout
684
self.stderr = sys.stderr
689
"""See progress.ProgressBar.clear()."""
691
def clear_term(self):
692
"""See progress.ProgressBar.clear_term()."""
694
def clear_term(self):
695
"""See progress.ProgressBar.clear_term()."""
698
"""See progress.ProgressBar.finished()."""
700
def note(self, fmt_string, *args, **kwargs):
701
"""See progress.ProgressBar.note()."""
702
self.stdout.write((fmt_string + "\n") % args)
704
def progress_bar(self):
707
def nested_progress_bar(self):
710
def update(self, message, count=None, total=None):
711
"""See progress.ProgressBar.update()."""
713
def get_non_echoed_password(self, prompt):
714
"""Get password from stdin without trying to handle the echo mode"""
716
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
717
password = self.stdin.readline()
720
if password[-1] == '\n':
721
password = password[:-1]
725
def _report_leaked_threads():
726
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
727
TestCase._first_thread_leaker_id,
728
TestCase._leaking_threads_tests)
731
class TestCase(unittest.TestCase):
732
"""Base class for bzr unit tests.
734
Tests that need access to disk resources should subclass
735
TestCaseInTempDir not TestCase.
737
Error and debug log messages are redirected from their usual
738
location into a temporary file, the contents of which can be
739
retrieved by _get_log(). We use a real OS file, not an in-memory object,
740
so that it can also capture file IO. When the test completes this file
741
is read into memory and removed from disk.
743
There are also convenience functions to invoke bzr's command-line
744
routine, and to build and check bzr trees.
746
In addition to the usual method of overriding tearDown(), this class also
747
allows subclasses to register functions into the _cleanups list, which is
748
run in order as the object is torn down. It's less likely this will be
749
accidentally overlooked.
752
_active_threads = None
753
_leaking_threads_tests = 0
754
_first_thread_leaker_id = None
755
_log_file_name = None
757
_keep_log_file = False
758
# record lsprof data when performing benchmark calls.
759
_gather_lsprof_in_benchmarks = False
760
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
761
'_log_contents', '_log_file_name', '_benchtime',
762
'_TestCase__testMethodName')
764
def __init__(self, methodName='testMethod'):
765
super(TestCase, self).__init__(methodName)
769
unittest.TestCase.setUp(self)
770
self._cleanEnvironment()
773
self._benchcalls = []
774
self._benchtime = None
776
self._clear_debug_flags()
777
TestCase._active_threads = threading.activeCount()
778
self.addCleanup(self._check_leaked_threads)
783
pdb.Pdb().set_trace(sys._getframe().f_back)
786
absent_attr = object()
787
exc_info = getattr(self, '_exc_info', absent_attr)
788
if exc_info is absent_attr:
789
exc_info = getattr(self, '_TestCase__exc_info')
792
def _check_leaked_threads(self):
793
active = threading.activeCount()
794
leaked_threads = active - TestCase._active_threads
795
TestCase._active_threads = active
797
TestCase._leaking_threads_tests += 1
798
if TestCase._first_thread_leaker_id is None:
799
TestCase._first_thread_leaker_id = self.id()
800
# we're not specifically told when all tests are finished.
801
# This will do. We use a function to avoid keeping a reference
802
# to a TestCase object.
803
atexit.register(_report_leaked_threads)
805
def _clear_debug_flags(self):
806
"""Prevent externally set debug flags affecting tests.
808
Tests that want to use debug flags can just set them in the
809
debug_flags set during setup/teardown.
811
self._preserved_debug_flags = set(debug.debug_flags)
812
if 'allow_debug' not in selftest_debug_flags:
813
debug.debug_flags.clear()
814
self.addCleanup(self._restore_debug_flags)
816
def _clear_hooks(self):
817
# prevent hooks affecting tests
818
self._preserved_hooks = {}
819
for key, factory in hooks.known_hooks.items():
820
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
821
current_hooks = hooks.known_hooks_key_to_object(key)
822
self._preserved_hooks[parent] = (name, current_hooks)
823
self.addCleanup(self._restoreHooks)
824
for key, factory in hooks.known_hooks.items():
825
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
826
setattr(parent, name, factory())
828
def _silenceUI(self):
829
"""Turn off UI for duration of test"""
830
# by default the UI is off; tests can turn it on if they want it.
831
saved = ui.ui_factory
833
ui.ui_factory = saved
834
ui.ui_factory = ui.SilentUIFactory()
835
self.addCleanup(_restore)
837
def _ndiff_strings(self, a, b):
838
"""Return ndiff between two strings containing lines.
840
A trailing newline is added if missing to make the strings
842
if b and b[-1] != '\n':
844
if a and a[-1] != '\n':
846
difflines = difflib.ndiff(a.splitlines(True),
848
linejunk=lambda x: False,
849
charjunk=lambda x: False)
850
return ''.join(difflines)
852
def assertEqual(self, a, b, message=''):
856
except UnicodeError, e:
857
# If we can't compare without getting a UnicodeError, then
858
# obviously they are different
859
mutter('UnicodeError: %s', e)
862
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
864
pformat(a), pformat(b)))
866
assertEquals = assertEqual
868
def assertEqualDiff(self, a, b, message=None):
869
"""Assert two texts are equal, if not raise an exception.
871
This is intended for use with multi-line strings where it can
872
be hard to find the differences by eye.
874
# TODO: perhaps override assertEquals to call this for strings?
878
message = "texts not equal:\n"
880
message = 'first string is missing a final newline.\n'
882
message = 'second string is missing a final newline.\n'
883
raise AssertionError(message +
884
self._ndiff_strings(a, b))
886
def assertEqualMode(self, mode, mode_test):
887
self.assertEqual(mode, mode_test,
888
'mode mismatch %o != %o' % (mode, mode_test))
890
def assertEqualStat(self, expected, actual):
891
"""assert that expected and actual are the same stat result.
893
:param expected: A stat result.
894
:param actual: A stat result.
895
:raises AssertionError: If the expected and actual stat values differ
898
self.assertEqual(expected.st_size, actual.st_size)
899
self.assertEqual(expected.st_mtime, actual.st_mtime)
900
self.assertEqual(expected.st_ctime, actual.st_ctime)
901
self.assertEqual(expected.st_dev, actual.st_dev)
902
self.assertEqual(expected.st_ino, actual.st_ino)
903
self.assertEqual(expected.st_mode, actual.st_mode)
905
def assertPositive(self, val):
906
"""Assert that val is greater than 0."""
907
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
909
def assertNegative(self, val):
910
"""Assert that val is less than 0."""
911
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
913
def assertStartsWith(self, s, prefix):
914
if not s.startswith(prefix):
915
raise AssertionError('string %r does not start with %r' % (s, prefix))
917
def assertEndsWith(self, s, suffix):
918
"""Asserts that s ends with suffix."""
919
if not s.endswith(suffix):
920
raise AssertionError('string %r does not end with %r' % (s, suffix))
922
def assertContainsRe(self, haystack, needle_re, flags=0):
923
"""Assert that a contains something matching a regular expression."""
924
if not re.search(needle_re, haystack, flags):
925
if '\n' in haystack or len(haystack) > 60:
926
# a long string, format it in a more readable way
927
raise AssertionError(
928
'pattern "%s" not found in\n"""\\\n%s"""\n'
929
% (needle_re, haystack))
931
raise AssertionError('pattern "%s" not found in "%s"'
932
% (needle_re, haystack))
934
def assertNotContainsRe(self, haystack, needle_re, flags=0):
935
"""Assert that a does not match a regular expression"""
936
if re.search(needle_re, haystack, flags):
937
raise AssertionError('pattern "%s" found in "%s"'
938
% (needle_re, haystack))
940
def assertSubset(self, sublist, superlist):
941
"""Assert that every entry in sublist is present in superlist."""
942
missing = set(sublist) - set(superlist)
944
raise AssertionError("value(s) %r not present in container %r" %
945
(missing, superlist))
947
def assertListRaises(self, excClass, func, *args, **kwargs):
948
"""Fail unless excClass is raised when the iterator from func is used.
950
Many functions can return generators this makes sure
951
to wrap them in a list() call to make sure the whole generator
952
is run, and that the proper exception is raised.
955
list(func(*args, **kwargs))
959
if getattr(excClass,'__name__', None) is not None:
960
excName = excClass.__name__
962
excName = str(excClass)
963
raise self.failureException, "%s not raised" % excName
965
def assertRaises(self, excClass, callableObj, *args, **kwargs):
966
"""Assert that a callable raises a particular exception.
968
:param excClass: As for the except statement, this may be either an
969
exception class, or a tuple of classes.
970
:param callableObj: A callable, will be passed ``*args`` and
973
Returns the exception so that you can examine it.
976
callableObj(*args, **kwargs)
980
if getattr(excClass,'__name__', None) is not None:
981
excName = excClass.__name__
984
excName = str(excClass)
985
raise self.failureException, "%s not raised" % excName
987
def assertIs(self, left, right, message=None):
988
if not (left is right):
989
if message is not None:
990
raise AssertionError(message)
992
raise AssertionError("%r is not %r." % (left, right))
994
def assertIsNot(self, left, right, message=None):
996
if message is not None:
997
raise AssertionError(message)
999
raise AssertionError("%r is %r." % (left, right))
1001
def assertTransportMode(self, transport, path, mode):
1002
"""Fail if a path does not have mode mode.
1004
If modes are not supported on this transport, the assertion is ignored.
1006
if not transport._can_roundtrip_unix_modebits():
1008
path_stat = transport.stat(path)
1009
actual_mode = stat.S_IMODE(path_stat.st_mode)
1010
self.assertEqual(mode, actual_mode,
1011
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1013
def assertIsSameRealPath(self, path1, path2):
1014
"""Fail if path1 and path2 points to different files"""
1015
self.assertEqual(osutils.realpath(path1),
1016
osutils.realpath(path2),
1017
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1019
def assertIsInstance(self, obj, kls):
1020
"""Fail if obj is not an instance of kls"""
1021
if not isinstance(obj, kls):
1022
self.fail("%r is an instance of %s rather than %s" % (
1023
obj, obj.__class__, kls))
1025
def expectFailure(self, reason, assertion, *args, **kwargs):
1026
"""Invoke a test, expecting it to fail for the given reason.
1028
This is for assertions that ought to succeed, but currently fail.
1029
(The failure is *expected* but not *wanted*.) Please be very precise
1030
about the failure you're expecting. If a new bug is introduced,
1031
AssertionError should be raised, not KnownFailure.
1033
Frequently, expectFailure should be followed by an opposite assertion.
1036
Intended to be used with a callable that raises AssertionError as the
1037
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1039
Raises KnownFailure if the test fails. Raises AssertionError if the
1044
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1046
self.assertEqual(42, dynamic_val)
1048
This means that a dynamic_val of 54 will cause the test to raise
1049
a KnownFailure. Once math is fixed and the expectFailure is removed,
1050
only a dynamic_val of 42 will allow the test to pass. Anything other
1051
than 54 or 42 will cause an AssertionError.
1054
assertion(*args, **kwargs)
1055
except AssertionError:
1056
raise KnownFailure(reason)
1058
self.fail('Unexpected success. Should have failed: %s' % reason)
1060
def assertFileEqual(self, content, path):
1061
"""Fail if path does not contain 'content'."""
1062
self.failUnlessExists(path)
1063
f = file(path, 'rb')
1068
self.assertEqualDiff(content, s)
1070
def failUnlessExists(self, path):
1071
"""Fail unless path or paths, which may be abs or relative, exist."""
1072
if not isinstance(path, basestring):
1074
self.failUnlessExists(p)
1076
self.failUnless(osutils.lexists(path),path+" does not exist")
1078
def failIfExists(self, path):
1079
"""Fail if path or paths, which may be abs or relative, exist."""
1080
if not isinstance(path, basestring):
1082
self.failIfExists(p)
1084
self.failIf(osutils.lexists(path),path+" exists")
1086
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1087
"""A helper for callDeprecated and applyDeprecated.
1089
:param a_callable: A callable to call.
1090
:param args: The positional arguments for the callable
1091
:param kwargs: The keyword arguments for the callable
1092
:return: A tuple (warnings, result). result is the result of calling
1093
a_callable(``*args``, ``**kwargs``).
1096
def capture_warnings(msg, cls=None, stacklevel=None):
1097
# we've hooked into a deprecation specific callpath,
1098
# only deprecations should getting sent via it.
1099
self.assertEqual(cls, DeprecationWarning)
1100
local_warnings.append(msg)
1101
original_warning_method = symbol_versioning.warn
1102
symbol_versioning.set_warning_method(capture_warnings)
1104
result = a_callable(*args, **kwargs)
1106
symbol_versioning.set_warning_method(original_warning_method)
1107
return (local_warnings, result)
1109
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1110
"""Call a deprecated callable without warning the user.
1112
Note that this only captures warnings raised by symbol_versioning.warn,
1113
not other callers that go direct to the warning module.
1115
To test that a deprecated method raises an error, do something like
1118
self.assertRaises(errors.ReservedId,
1119
self.applyDeprecated,
1120
deprecated_in((1, 5, 0)),
1124
:param deprecation_format: The deprecation format that the callable
1125
should have been deprecated with. This is the same type as the
1126
parameter to deprecated_method/deprecated_function. If the
1127
callable is not deprecated with this format, an assertion error
1129
:param a_callable: A callable to call. This may be a bound method or
1130
a regular function. It will be called with ``*args`` and
1132
:param args: The positional arguments for the callable
1133
:param kwargs: The keyword arguments for the callable
1134
:return: The result of a_callable(``*args``, ``**kwargs``)
1136
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1138
expected_first_warning = symbol_versioning.deprecation_string(
1139
a_callable, deprecation_format)
1140
if len(call_warnings) == 0:
1141
self.fail("No deprecation warning generated by call to %s" %
1143
self.assertEqual(expected_first_warning, call_warnings[0])
1146
def callCatchWarnings(self, fn, *args, **kw):
1147
"""Call a callable that raises python warnings.
1149
The caller's responsible for examining the returned warnings.
1151
If the callable raises an exception, the exception is not
1152
caught and propagates up to the caller. In that case, the list
1153
of warnings is not available.
1155
:returns: ([warning_object, ...], fn_result)
1157
# XXX: This is not perfect, because it completely overrides the
1158
# warnings filters, and some code may depend on suppressing particular
1159
# warnings. It's the easiest way to insulate ourselves from -Werror,
1160
# though. -- Andrew, 20071062
1162
def _catcher(message, category, filename, lineno, file=None, line=None):
1163
# despite the name, 'message' is normally(?) a Warning subclass
1165
wlist.append(message)
1166
saved_showwarning = warnings.showwarning
1167
saved_filters = warnings.filters
1169
warnings.showwarning = _catcher
1170
warnings.filters = []
1171
result = fn(*args, **kw)
1173
warnings.showwarning = saved_showwarning
1174
warnings.filters = saved_filters
1175
return wlist, result
1177
def callDeprecated(self, expected, callable, *args, **kwargs):
1178
"""Assert that a callable is deprecated in a particular way.
1180
This is a very precise test for unusual requirements. The
1181
applyDeprecated helper function is probably more suited for most tests
1182
as it allows you to simply specify the deprecation format being used
1183
and will ensure that that is issued for the function being called.
1185
Note that this only captures warnings raised by symbol_versioning.warn,
1186
not other callers that go direct to the warning module. To catch
1187
general warnings, use callCatchWarnings.
1189
:param expected: a list of the deprecation warnings expected, in order
1190
:param callable: The callable to call
1191
:param args: The positional arguments for the callable
1192
:param kwargs: The keyword arguments for the callable
1194
call_warnings, result = self._capture_deprecation_warnings(callable,
1196
self.assertEqual(expected, call_warnings)
1199
def _startLogFile(self):
1200
"""Send bzr and test log messages to a temporary file.
1202
The file is removed as the test is torn down.
1204
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1205
self._log_file = os.fdopen(fileno, 'w+')
1206
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1207
self._log_file_name = name
1208
self.addCleanup(self._finishLogFile)
1210
def _finishLogFile(self):
1211
"""Finished with the log file.
1213
Close the file and delete it, unless setKeepLogfile was called.
1215
if self._log_file is None:
1217
bzrlib.trace.pop_log_file(self._log_memento)
1218
self._log_file.close()
1219
self._log_file = None
1220
if not self._keep_log_file:
1221
os.remove(self._log_file_name)
1222
self._log_file_name = None
1224
def setKeepLogfile(self):
1225
"""Make the logfile not be deleted when _finishLogFile is called."""
1226
self._keep_log_file = True
1228
def addCleanup(self, callable, *args, **kwargs):
1229
"""Arrange to run a callable when this case is torn down.
1231
Callables are run in the reverse of the order they are registered,
1232
ie last-in first-out.
1234
self._cleanups.append((callable, args, kwargs))
1236
def _cleanEnvironment(self):
1238
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1239
'HOME': os.getcwd(),
1240
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1241
# tests do check our impls match APPDATA
1242
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1244
'BZREMAIL': None, # may still be present in the environment
1246
'BZR_PROGRESS_BAR': None,
1248
'BZR_PLUGIN_PATH': None,
1250
'SSH_AUTH_SOCK': None,
1254
'https_proxy': None,
1255
'HTTPS_PROXY': None,
1260
# Nobody cares about these ones AFAIK. So far at
1261
# least. If you do (care), please update this comment
1265
'BZR_REMOTE_PATH': None,
1268
self.addCleanup(self._restoreEnvironment)
1269
for name, value in new_env.iteritems():
1270
self._captureVar(name, value)
1272
def _captureVar(self, name, newvalue):
1273
"""Set an environment variable, and reset it when finished."""
1274
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1276
def _restore_debug_flags(self):
1277
debug.debug_flags.clear()
1278
debug.debug_flags.update(self._preserved_debug_flags)
1280
def _restoreEnvironment(self):
1281
for name, value in self.__old_env.iteritems():
1282
osutils.set_or_unset_env(name, value)
1284
def _restoreHooks(self):
1285
for klass, (name, hooks) in self._preserved_hooks.items():
1286
setattr(klass, name, hooks)
1288
def knownFailure(self, reason):
1289
"""This test has failed for some known reason."""
1290
raise KnownFailure(reason)
1292
def _do_skip(self, result, reason):
1293
addSkip = getattr(result, 'addSkip', None)
1294
if not callable(addSkip):
1295
result.addError(self, self.exc_info())
1297
addSkip(self, reason)
1299
def run(self, result=None):
1300
if result is None: result = self.defaultTestResult()
1301
for feature in getattr(self, '_test_needs_features', []):
1302
if not feature.available():
1303
result.startTest(self)
1304
if getattr(result, 'addNotSupported', None):
1305
result.addNotSupported(self, feature)
1307
result.addSuccess(self)
1308
result.stopTest(self)
1312
result.startTest(self)
1313
absent_attr = object()
1315
method_name = getattr(self, '_testMethodName', absent_attr)
1316
if method_name is absent_attr:
1318
method_name = getattr(self, '_TestCase__testMethodName')
1319
testMethod = getattr(self, method_name)
1323
except KeyboardInterrupt:
1325
except TestSkipped, e:
1326
self._do_skip(result, e.args[0])
1330
result.addError(self, self.exc_info())
1337
except self.failureException:
1338
result.addFailure(self, self.exc_info())
1339
except TestSkipped, e:
1341
reason = "No reason given."
1344
self._do_skip(result, reason)
1345
except KeyboardInterrupt:
1348
result.addError(self, self.exc_info())
1352
except KeyboardInterrupt:
1355
result.addError(self, self.exc_info())
1357
if ok: result.addSuccess(self)
1359
result.stopTest(self)
1361
except TestNotApplicable:
1362
# Not moved from the result [yet].
1364
except KeyboardInterrupt:
1368
absent_attr = object()
1369
for attr_name in self.attrs_to_keep:
1370
attr = getattr(self, attr_name, absent_attr)
1371
if attr is not absent_attr:
1372
saved_attrs[attr_name] = attr
1373
self.__dict__ = saved_attrs
1377
self._log_contents = ''
1378
unittest.TestCase.tearDown(self)
1380
def time(self, callable, *args, **kwargs):
1381
"""Run callable and accrue the time it takes to the benchmark time.
1383
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1384
this will cause lsprofile statistics to be gathered and stored in
1387
if self._benchtime is None:
1391
if not self._gather_lsprof_in_benchmarks:
1392
return callable(*args, **kwargs)
1394
# record this benchmark
1395
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1397
self._benchcalls.append(((callable, args, kwargs), stats))
1400
self._benchtime += time.time() - start
1402
def _runCleanups(self):
1403
"""Run registered cleanup functions.
1405
This should only be called from TestCase.tearDown.
1407
# TODO: Perhaps this should keep running cleanups even if
1408
# one of them fails?
1410
# Actually pop the cleanups from the list so tearDown running
1411
# twice is safe (this happens for skipped tests).
1412
while self._cleanups:
1413
cleanup, args, kwargs = self._cleanups.pop()
1414
cleanup(*args, **kwargs)
1416
def log(self, *args):
1419
def _get_log(self, keep_log_file=False):
1420
"""Get the log from bzrlib.trace calls from this test.
1422
:param keep_log_file: When True, if the log is still a file on disk
1423
leave it as a file on disk. When False, if the log is still a file
1424
on disk, the log file is deleted and the log preserved as
1426
:return: A string containing the log.
1428
# flush the log file, to get all content
1430
if bzrlib.trace._trace_file:
1431
bzrlib.trace._trace_file.flush()
1432
if self._log_contents:
1433
# XXX: this can hardly contain the content flushed above --vila
1435
return self._log_contents
1436
if self._log_file_name is not None:
1437
logfile = open(self._log_file_name)
1439
log_contents = logfile.read()
1442
if not keep_log_file:
1443
self._log_contents = log_contents
1445
os.remove(self._log_file_name)
1447
if sys.platform == 'win32' and e.errno == errno.EACCES:
1448
sys.stderr.write(('Unable to delete log file '
1449
' %r\n' % self._log_file_name))
1454
return "DELETED log file to reduce memory footprint"
1456
def requireFeature(self, feature):
1457
"""This test requires a specific feature is available.
1459
:raises UnavailableFeature: When feature is not available.
1461
if not feature.available():
1462
raise UnavailableFeature(feature)
1464
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1466
"""Run bazaar command line, splitting up a string command line."""
1467
if isinstance(args, basestring):
1468
# shlex don't understand unicode strings,
1469
# so args should be plain string (bialix 20070906)
1470
args = list(shlex.split(str(args)))
1471
return self._run_bzr_core(args, retcode=retcode,
1472
encoding=encoding, stdin=stdin, working_dir=working_dir,
1475
def _run_bzr_core(self, args, retcode, encoding, stdin,
1477
if encoding is None:
1478
encoding = osutils.get_user_encoding()
1479
stdout = StringIOWrapper()
1480
stderr = StringIOWrapper()
1481
stdout.encoding = encoding
1482
stderr.encoding = encoding
1484
self.log('run bzr: %r', args)
1485
# FIXME: don't call into logging here
1486
handler = logging.StreamHandler(stderr)
1487
handler.setLevel(logging.INFO)
1488
logger = logging.getLogger('')
1489
logger.addHandler(handler)
1490
old_ui_factory = ui.ui_factory
1491
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1494
if working_dir is not None:
1495
cwd = osutils.getcwd()
1496
os.chdir(working_dir)
1499
result = self.apply_redirected(ui.ui_factory.stdin,
1501
bzrlib.commands.run_bzr_catch_user_errors,
1504
logger.removeHandler(handler)
1505
ui.ui_factory = old_ui_factory
1509
out = stdout.getvalue()
1510
err = stderr.getvalue()
1512
self.log('output:\n%r', out)
1514
self.log('errors:\n%r', err)
1515
if retcode is not None:
1516
self.assertEquals(retcode, result,
1517
message='Unexpected return code')
1520
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1521
working_dir=None, error_regexes=[], output_encoding=None):
1522
"""Invoke bzr, as if it were run from the command line.
1524
The argument list should not include the bzr program name - the
1525
first argument is normally the bzr command. Arguments may be
1526
passed in three ways:
1528
1- A list of strings, eg ["commit", "a"]. This is recommended
1529
when the command contains whitespace or metacharacters, or
1530
is built up at run time.
1532
2- A single string, eg "add a". This is the most convenient
1533
for hardcoded commands.
1535
This runs bzr through the interface that catches and reports
1536
errors, and with logging set to something approximating the
1537
default, so that error reporting can be checked.
1539
This should be the main method for tests that want to exercise the
1540
overall behavior of the bzr application (rather than a unit test
1541
or a functional test of the library.)
1543
This sends the stdout/stderr results into the test's log,
1544
where it may be useful for debugging. See also run_captured.
1546
:keyword stdin: A string to be used as stdin for the command.
1547
:keyword retcode: The status code the command should return;
1549
:keyword working_dir: The directory to run the command in
1550
:keyword error_regexes: A list of expected error messages. If
1551
specified they must be seen in the error output of the command.
1553
out, err = self._run_bzr_autosplit(
1558
working_dir=working_dir,
1560
for regex in error_regexes:
1561
self.assertContainsRe(err, regex)
1564
def run_bzr_error(self, error_regexes, *args, **kwargs):
1565
"""Run bzr, and check that stderr contains the supplied regexes
1567
:param error_regexes: Sequence of regular expressions which
1568
must each be found in the error output. The relative ordering
1570
:param args: command-line arguments for bzr
1571
:param kwargs: Keyword arguments which are interpreted by run_bzr
1572
This function changes the default value of retcode to be 3,
1573
since in most cases this is run when you expect bzr to fail.
1575
:return: (out, err) The actual output of running the command (in case
1576
you want to do more inspection)
1580
# Make sure that commit is failing because there is nothing to do
1581
self.run_bzr_error(['no changes to commit'],
1582
['commit', '-m', 'my commit comment'])
1583
# Make sure --strict is handling an unknown file, rather than
1584
# giving us the 'nothing to do' error
1585
self.build_tree(['unknown'])
1586
self.run_bzr_error(['Commit refused because there are unknown files'],
1587
['commit', --strict', '-m', 'my commit comment'])
1589
kwargs.setdefault('retcode', 3)
1590
kwargs['error_regexes'] = error_regexes
1591
out, err = self.run_bzr(*args, **kwargs)
1594
def run_bzr_subprocess(self, *args, **kwargs):
1595
"""Run bzr in a subprocess for testing.
1597
This starts a new Python interpreter and runs bzr in there.
1598
This should only be used for tests that have a justifiable need for
1599
this isolation: e.g. they are testing startup time, or signal
1600
handling, or early startup code, etc. Subprocess code can't be
1601
profiled or debugged so easily.
1603
:keyword retcode: The status code that is expected. Defaults to 0. If
1604
None is supplied, the status code is not checked.
1605
:keyword env_changes: A dictionary which lists changes to environment
1606
variables. A value of None will unset the env variable.
1607
The values must be strings. The change will only occur in the
1608
child, so you don't need to fix the environment after running.
1609
:keyword universal_newlines: Convert CRLF => LF
1610
:keyword allow_plugins: By default the subprocess is run with
1611
--no-plugins to ensure test reproducibility. Also, it is possible
1612
for system-wide plugins to create unexpected output on stderr,
1613
which can cause unnecessary test failures.
1615
env_changes = kwargs.get('env_changes', {})
1616
working_dir = kwargs.get('working_dir', None)
1617
allow_plugins = kwargs.get('allow_plugins', False)
1619
if isinstance(args[0], list):
1621
elif isinstance(args[0], basestring):
1622
args = list(shlex.split(args[0]))
1624
raise ValueError("passing varargs to run_bzr_subprocess")
1625
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1626
working_dir=working_dir,
1627
allow_plugins=allow_plugins)
1628
# We distinguish between retcode=None and retcode not passed.
1629
supplied_retcode = kwargs.get('retcode', 0)
1630
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1631
universal_newlines=kwargs.get('universal_newlines', False),
1634
def start_bzr_subprocess(self, process_args, env_changes=None,
1635
skip_if_plan_to_signal=False,
1637
allow_plugins=False):
1638
"""Start bzr in a subprocess for testing.
1640
This starts a new Python interpreter and runs bzr in there.
1641
This should only be used for tests that have a justifiable need for
1642
this isolation: e.g. they are testing startup time, or signal
1643
handling, or early startup code, etc. Subprocess code can't be
1644
profiled or debugged so easily.
1646
:param process_args: a list of arguments to pass to the bzr executable,
1647
for example ``['--version']``.
1648
:param env_changes: A dictionary which lists changes to environment
1649
variables. A value of None will unset the env variable.
1650
The values must be strings. The change will only occur in the
1651
child, so you don't need to fix the environment after running.
1652
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1654
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1656
:returns: Popen object for the started process.
1658
if skip_if_plan_to_signal:
1659
if not getattr(os, 'kill', None):
1660
raise TestSkipped("os.kill not available.")
1662
if env_changes is None:
1666
def cleanup_environment():
1667
for env_var, value in env_changes.iteritems():
1668
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1670
def restore_environment():
1671
for env_var, value in old_env.iteritems():
1672
osutils.set_or_unset_env(env_var, value)
1674
bzr_path = self.get_bzr_path()
1677
if working_dir is not None:
1678
cwd = osutils.getcwd()
1679
os.chdir(working_dir)
1682
# win32 subprocess doesn't support preexec_fn
1683
# so we will avoid using it on all platforms, just to
1684
# make sure the code path is used, and we don't break on win32
1685
cleanup_environment()
1686
command = [sys.executable]
1687
# frozen executables don't need the path to bzr
1688
if getattr(sys, "frozen", None) is None:
1689
command.append(bzr_path)
1690
if not allow_plugins:
1691
command.append('--no-plugins')
1692
command.extend(process_args)
1693
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1695
restore_environment()
1701
def _popen(self, *args, **kwargs):
1702
"""Place a call to Popen.
1704
Allows tests to override this method to intercept the calls made to
1705
Popen for introspection.
1707
return Popen(*args, **kwargs)
1709
def get_bzr_path(self):
1710
"""Return the path of the 'bzr' executable for this test suite."""
1711
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1712
if not os.path.isfile(bzr_path):
1713
# We are probably installed. Assume sys.argv is the right file
1714
bzr_path = sys.argv[0]
1717
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1718
universal_newlines=False, process_args=None):
1719
"""Finish the execution of process.
1721
:param process: the Popen object returned from start_bzr_subprocess.
1722
:param retcode: The status code that is expected. Defaults to 0. If
1723
None is supplied, the status code is not checked.
1724
:param send_signal: an optional signal to send to the process.
1725
:param universal_newlines: Convert CRLF => LF
1726
:returns: (stdout, stderr)
1728
if send_signal is not None:
1729
os.kill(process.pid, send_signal)
1730
out, err = process.communicate()
1732
if universal_newlines:
1733
out = out.replace('\r\n', '\n')
1734
err = err.replace('\r\n', '\n')
1736
if retcode is not None and retcode != process.returncode:
1737
if process_args is None:
1738
process_args = "(unknown args)"
1739
mutter('Output of bzr %s:\n%s', process_args, out)
1740
mutter('Error for bzr %s:\n%s', process_args, err)
1741
self.fail('Command bzr %s failed with retcode %s != %s'
1742
% (process_args, retcode, process.returncode))
1745
def check_inventory_shape(self, inv, shape):
1746
"""Compare an inventory to a list of expected names.
1748
Fail if they are not precisely equal.
1751
shape = list(shape) # copy
1752
for path, ie in inv.entries():
1753
name = path.replace('\\', '/')
1754
if ie.kind == 'directory':
1761
self.fail("expected paths not found in inventory: %r" % shape)
1763
self.fail("unexpected paths found in inventory: %r" % extras)
1765
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1766
a_callable=None, *args, **kwargs):
1767
"""Call callable with redirected std io pipes.
1769
Returns the return code."""
1770
if not callable(a_callable):
1771
raise ValueError("a_callable must be callable.")
1773
stdin = StringIO("")
1775
if getattr(self, "_log_file", None) is not None:
1776
stdout = self._log_file
1780
if getattr(self, "_log_file", None is not None):
1781
stderr = self._log_file
1784
real_stdin = sys.stdin
1785
real_stdout = sys.stdout
1786
real_stderr = sys.stderr
1791
return a_callable(*args, **kwargs)
1793
sys.stdout = real_stdout
1794
sys.stderr = real_stderr
1795
sys.stdin = real_stdin
1797
def reduceLockdirTimeout(self):
1798
"""Reduce the default lock timeout for the duration of the test, so that
1799
if LockContention occurs during a test, it does so quickly.
1801
Tests that expect to provoke LockContention errors should call this.
1803
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1805
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1806
self.addCleanup(resetTimeout)
1807
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1809
def make_utf8_encoded_stringio(self, encoding_type=None):
1810
"""Return a StringIOWrapper instance, that will encode Unicode
1813
if encoding_type is None:
1814
encoding_type = 'strict'
1816
output_encoding = 'utf-8'
1817
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1818
sio.encoding = output_encoding
1822
class CapturedCall(object):
1823
"""A helper for capturing smart server calls for easy debug analysis."""
1825
def __init__(self, params, prefix_length):
1826
"""Capture the call with params and skip prefix_length stack frames."""
1829
# The last 5 frames are the __init__, the hook frame, and 3 smart
1830
# client frames. Beyond this we could get more clever, but this is good
1832
stack = traceback.extract_stack()[prefix_length:-5]
1833
self.stack = ''.join(traceback.format_list(stack))
1836
return self.call.method
1839
return self.call.method
1845
class TestCaseWithMemoryTransport(TestCase):
1846
"""Common test class for tests that do not need disk resources.
1848
Tests that need disk resources should derive from TestCaseWithTransport.
1850
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1852
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1853
a directory which does not exist. This serves to help ensure test isolation
1854
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1855
must exist. However, TestCaseWithMemoryTransport does not offer local
1856
file defaults for the transport in tests, nor does it obey the command line
1857
override, so tests that accidentally write to the common directory should
1860
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1861
a .bzr directory that stops us ascending higher into the filesystem.
1867
def __init__(self, methodName='runTest'):
1868
# allow test parameterization after test construction and before test
1869
# execution. Variables that the parameterizer sets need to be
1870
# ones that are not set by setUp, or setUp will trash them.
1871
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1872
self.vfs_transport_factory = default_transport
1873
self.transport_server = None
1874
self.transport_readonly_server = None
1875
self.__vfs_server = None
1877
def get_transport(self, relpath=None):
1878
"""Return a writeable transport.
1880
This transport is for the test scratch space relative to
1883
:param relpath: a path relative to the base url.
1885
t = get_transport(self.get_url(relpath))
1886
self.assertFalse(t.is_readonly())
1889
def get_readonly_transport(self, relpath=None):
1890
"""Return a readonly transport for the test scratch space
1892
This can be used to test that operations which should only need
1893
readonly access in fact do not try to write.
1895
:param relpath: a path relative to the base url.
1897
t = get_transport(self.get_readonly_url(relpath))
1898
self.assertTrue(t.is_readonly())
1901
def create_transport_readonly_server(self):
1902
"""Create a transport server from class defined at init.
1904
This is mostly a hook for daughter classes.
1906
return self.transport_readonly_server()
1908
def get_readonly_server(self):
1909
"""Get the server instance for the readonly transport
1911
This is useful for some tests with specific servers to do diagnostics.
1913
if self.__readonly_server is None:
1914
if self.transport_readonly_server is None:
1915
# readonly decorator requested
1916
# bring up the server
1917
self.__readonly_server = ReadonlyServer()
1918
self.__readonly_server.setUp(self.get_vfs_only_server())
1920
self.__readonly_server = self.create_transport_readonly_server()
1921
self.__readonly_server.setUp(self.get_vfs_only_server())
1922
self.addCleanup(self.__readonly_server.tearDown)
1923
return self.__readonly_server
1925
def get_readonly_url(self, relpath=None):
1926
"""Get a URL for the readonly transport.
1928
This will either be backed by '.' or a decorator to the transport
1929
used by self.get_url()
1930
relpath provides for clients to get a path relative to the base url.
1931
These should only be downwards relative, not upwards.
1933
base = self.get_readonly_server().get_url()
1934
return self._adjust_url(base, relpath)
1936
def get_vfs_only_server(self):
1937
"""Get the vfs only read/write server instance.
1939
This is useful for some tests with specific servers that need
1942
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1943
is no means to override it.
1945
if self.__vfs_server is None:
1946
self.__vfs_server = MemoryServer()
1947
self.__vfs_server.setUp()
1948
self.addCleanup(self.__vfs_server.tearDown)
1949
return self.__vfs_server
1951
def get_server(self):
1952
"""Get the read/write server instance.
1954
This is useful for some tests with specific servers that need
1957
This is built from the self.transport_server factory. If that is None,
1958
then the self.get_vfs_server is returned.
1960
if self.__server is None:
1961
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1962
return self.get_vfs_only_server()
1964
# bring up a decorated means of access to the vfs only server.
1965
self.__server = self.transport_server()
1967
self.__server.setUp(self.get_vfs_only_server())
1968
except TypeError, e:
1969
# This should never happen; the try:Except here is to assist
1970
# developers having to update code rather than seeing an
1971
# uninformative TypeError.
1972
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1973
self.addCleanup(self.__server.tearDown)
1974
return self.__server
1976
def _adjust_url(self, base, relpath):
1977
"""Get a URL (or maybe a path) for the readwrite transport.
1979
This will either be backed by '.' or to an equivalent non-file based
1981
relpath provides for clients to get a path relative to the base url.
1982
These should only be downwards relative, not upwards.
1984
if relpath is not None and relpath != '.':
1985
if not base.endswith('/'):
1987
# XXX: Really base should be a url; we did after all call
1988
# get_url()! But sometimes it's just a path (from
1989
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1990
# to a non-escaped local path.
1991
if base.startswith('./') or base.startswith('/'):
1994
base += urlutils.escape(relpath)
1997
def get_url(self, relpath=None):
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
base = self.get_server().get_url()
2006
return self._adjust_url(base, relpath)
2008
def get_vfs_only_url(self, relpath=None):
2009
"""Get a URL (or maybe a path for the plain old vfs transport.
2011
This will never be a smart protocol. It always has all the
2012
capabilities of the local filesystem, but it might actually be a
2013
MemoryTransport or some other similar virtual filesystem.
2015
This is the backing transport (if any) of the server returned by
2016
get_url and get_readonly_url.
2018
:param relpath: provides for clients to get a path relative to the base
2019
url. These should only be downwards relative, not upwards.
2022
base = self.get_vfs_only_server().get_url()
2023
return self._adjust_url(base, relpath)
2025
def _create_safety_net(self):
2026
"""Make a fake bzr directory.
2028
This prevents any tests propagating up onto the TEST_ROOT directory's
2031
root = TestCaseWithMemoryTransport.TEST_ROOT
2032
bzrdir.BzrDir.create_standalone_workingtree(root)
2034
def _check_safety_net(self):
2035
"""Check that the safety .bzr directory have not been touched.
2037
_make_test_root have created a .bzr directory to prevent tests from
2038
propagating. This method ensures than a test did not leaked.
2040
root = TestCaseWithMemoryTransport.TEST_ROOT
2041
wt = workingtree.WorkingTree.open(root)
2042
last_rev = wt.last_revision()
2043
if last_rev != 'null:':
2044
# The current test have modified the /bzr directory, we need to
2045
# recreate a new one or all the followng tests will fail.
2046
# If you need to inspect its content uncomment the following line
2047
# import pdb; pdb.set_trace()
2048
_rmtree_temp_dir(root + '/.bzr')
2049
self._create_safety_net()
2050
raise AssertionError('%s/.bzr should not be modified' % root)
2052
def _make_test_root(self):
2053
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2054
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2055
TestCaseWithMemoryTransport.TEST_ROOT = root
2057
self._create_safety_net()
2059
# The same directory is used by all tests, and we're not
2060
# specifically told when all tests are finished. This will do.
2061
atexit.register(_rmtree_temp_dir, root)
2063
self.addCleanup(self._check_safety_net)
2065
def makeAndChdirToTestDir(self):
2066
"""Create a temporary directories for this one test.
2068
This must set self.test_home_dir and self.test_dir and chdir to
2071
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2073
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2074
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2075
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2077
def make_branch(self, relpath, format=None):
2078
"""Create a branch on the transport at relpath."""
2079
repo = self.make_repository(relpath, format=format)
2080
return repo.bzrdir.create_branch()
2082
def make_bzrdir(self, relpath, format=None):
2084
# might be a relative or absolute path
2085
maybe_a_url = self.get_url(relpath)
2086
segments = maybe_a_url.rsplit('/', 1)
2087
t = get_transport(maybe_a_url)
2088
if len(segments) > 1 and segments[-1] not in ('', '.'):
2092
if isinstance(format, basestring):
2093
format = bzrdir.format_registry.make_bzrdir(format)
2094
return format.initialize_on_transport(t)
2095
except errors.UninitializableFormat:
2096
raise TestSkipped("Format %s is not initializable." % format)
2098
def make_repository(self, relpath, shared=False, format=None):
2099
"""Create a repository on our default transport at relpath.
2101
Note that relpath must be a relative path, not a full url.
2103
# FIXME: If you create a remoterepository this returns the underlying
2104
# real format, which is incorrect. Actually we should make sure that
2105
# RemoteBzrDir returns a RemoteRepository.
2106
# maybe mbp 20070410
2107
made_control = self.make_bzrdir(relpath, format=format)
2108
return made_control.create_repository(shared=shared)
2110
def make_branch_and_memory_tree(self, relpath, format=None):
2111
"""Create a branch on the default transport and a MemoryTree for it."""
2112
b = self.make_branch(relpath, format=format)
2113
return memorytree.MemoryTree.create_on_branch(b)
2115
def make_branch_builder(self, relpath, format=None):
2116
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2119
def overrideEnvironmentForTesting(self):
2120
os.environ['HOME'] = self.test_home_dir
2121
os.environ['BZR_HOME'] = self.test_home_dir
2124
super(TestCaseWithMemoryTransport, self).setUp()
2125
self._make_test_root()
2126
_currentdir = os.getcwdu()
2127
def _leaveDirectory():
2128
os.chdir(_currentdir)
2129
self.addCleanup(_leaveDirectory)
2130
self.makeAndChdirToTestDir()
2131
self.overrideEnvironmentForTesting()
2132
self.__readonly_server = None
2133
self.__server = None
2134
self.reduceLockdirTimeout()
2136
def setup_smart_server_with_call_log(self):
2137
"""Sets up a smart server as the transport server with a call log."""
2138
self.transport_server = server.SmartTCPServer_for_testing
2139
self.hpss_calls = []
2141
# Skip the current stack down to the caller of
2142
# setup_smart_server_with_call_log
2143
prefix_length = len(traceback.extract_stack()) - 2
2144
def capture_hpss_call(params):
2145
self.hpss_calls.append(
2146
CapturedCall(params, prefix_length))
2147
client._SmartClient.hooks.install_named_hook(
2148
'call', capture_hpss_call, None)
2150
def reset_smart_call_log(self):
2151
self.hpss_calls = []
2154
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2155
"""Derived class that runs a test within a temporary directory.
2157
This is useful for tests that need to create a branch, etc.
2159
The directory is created in a slightly complex way: for each
2160
Python invocation, a new temporary top-level directory is created.
2161
All test cases create their own directory within that. If the
2162
tests complete successfully, the directory is removed.
2164
:ivar test_base_dir: The path of the top-level directory for this
2165
test, which contains a home directory and a work directory.
2167
:ivar test_home_dir: An initially empty directory under test_base_dir
2168
which is used as $HOME for this test.
2170
:ivar test_dir: A directory under test_base_dir used as the current
2171
directory when the test proper is run.
2174
OVERRIDE_PYTHON = 'python'
2176
def check_file_contents(self, filename, expect):
2177
self.log("check contents of file %s" % filename)
2178
contents = file(filename, 'r').read()
2179
if contents != expect:
2180
self.log("expected: %r" % expect)
2181
self.log("actually: %r" % contents)
2182
self.fail("contents of %s not as expected" % filename)
2184
def _getTestDirPrefix(self):
2185
# create a directory within the top level test directory
2186
if sys.platform == 'win32':
2187
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2188
# windows is likely to have path-length limits so use a short name
2189
name_prefix = name_prefix[-30:]
2191
name_prefix = re.sub('[/]', '_', self.id())
2194
def makeAndChdirToTestDir(self):
2195
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2197
For TestCaseInTempDir we create a temporary directory based on the test
2198
name and then create two subdirs - test and home under it.
2200
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2202
for i in range(100):
2203
if os.path.exists(name):
2204
name = name_prefix + '_' + str(i)
2208
# now create test and home directories within this dir
2209
self.test_base_dir = name
2210
self.test_home_dir = self.test_base_dir + '/home'
2211
os.mkdir(self.test_home_dir)
2212
self.test_dir = self.test_base_dir + '/work'
2213
os.mkdir(self.test_dir)
2214
os.chdir(self.test_dir)
2215
# put name of test inside
2216
f = file(self.test_base_dir + '/name', 'w')
2221
self.addCleanup(self.deleteTestDir)
2223
def deleteTestDir(self):
2224
os.chdir(self.TEST_ROOT)
2225
_rmtree_temp_dir(self.test_base_dir)
2227
def build_tree(self, shape, line_endings='binary', transport=None):
2228
"""Build a test tree according to a pattern.
2230
shape is a sequence of file specifications. If the final
2231
character is '/', a directory is created.
2233
This assumes that all the elements in the tree being built are new.
2235
This doesn't add anything to a branch.
2237
:type shape: list or tuple.
2238
:param line_endings: Either 'binary' or 'native'
2239
in binary mode, exact contents are written in native mode, the
2240
line endings match the default platform endings.
2241
:param transport: A transport to write to, for building trees on VFS's.
2242
If the transport is readonly or None, "." is opened automatically.
2245
if type(shape) not in (list, tuple):
2246
raise AssertionError("Parameter 'shape' should be "
2247
"a list or a tuple. Got %r instead" % (shape,))
2248
# It's OK to just create them using forward slashes on windows.
2249
if transport is None or transport.is_readonly():
2250
transport = get_transport(".")
2252
self.assertIsInstance(name, basestring)
2254
transport.mkdir(urlutils.escape(name[:-1]))
2256
if line_endings == 'binary':
2258
elif line_endings == 'native':
2261
raise errors.BzrError(
2262
'Invalid line ending request %r' % line_endings)
2263
content = "contents of %s%s" % (name.encode('utf-8'), end)
2264
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2266
def build_tree_contents(self, shape):
2267
build_tree_contents(shape)
2269
def assertInWorkingTree(self, path, root_path='.', tree=None):
2270
"""Assert whether path or paths are in the WorkingTree"""
2272
tree = workingtree.WorkingTree.open(root_path)
2273
if not isinstance(path, basestring):
2275
self.assertInWorkingTree(p, tree=tree)
2277
self.assertIsNot(tree.path2id(path), None,
2278
path+' not in working tree.')
2280
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2281
"""Assert whether path or paths are not in the WorkingTree"""
2283
tree = workingtree.WorkingTree.open(root_path)
2284
if not isinstance(path, basestring):
2286
self.assertNotInWorkingTree(p,tree=tree)
2288
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2291
class TestCaseWithTransport(TestCaseInTempDir):
2292
"""A test case that provides get_url and get_readonly_url facilities.
2294
These back onto two transport servers, one for readonly access and one for
2297
If no explicit class is provided for readonly access, a
2298
ReadonlyTransportDecorator is used instead which allows the use of non disk
2299
based read write transports.
2301
If an explicit class is provided for readonly access, that server and the
2302
readwrite one must both define get_url() as resolving to os.getcwd().
2305
def get_vfs_only_server(self):
2306
"""See TestCaseWithMemoryTransport.
2308
This is useful for some tests with specific servers that need
2311
if self.__vfs_server is None:
2312
self.__vfs_server = self.vfs_transport_factory()
2313
self.__vfs_server.setUp()
2314
self.addCleanup(self.__vfs_server.tearDown)
2315
return self.__vfs_server
2317
def make_branch_and_tree(self, relpath, format=None):
2318
"""Create a branch on the transport and a tree locally.
2320
If the transport is not a LocalTransport, the Tree can't be created on
2321
the transport. In that case if the vfs_transport_factory is
2322
LocalURLServer the working tree is created in the local
2323
directory backing the transport, and the returned tree's branch and
2324
repository will also be accessed locally. Otherwise a lightweight
2325
checkout is created and returned.
2327
:param format: The BzrDirFormat.
2328
:returns: the WorkingTree.
2330
# TODO: always use the local disk path for the working tree,
2331
# this obviously requires a format that supports branch references
2332
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2334
b = self.make_branch(relpath, format=format)
2336
return b.bzrdir.create_workingtree()
2337
except errors.NotLocalUrl:
2338
# We can only make working trees locally at the moment. If the
2339
# transport can't support them, then we keep the non-disk-backed
2340
# branch and create a local checkout.
2341
if self.vfs_transport_factory is LocalURLServer:
2342
# the branch is colocated on disk, we cannot create a checkout.
2343
# hopefully callers will expect this.
2344
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2345
wt = local_controldir.create_workingtree()
2346
if wt.branch._format != b._format:
2348
# Make sure that assigning to wt._branch fixes wt.branch,
2349
# in case the implementation details of workingtree objects
2351
self.assertIs(b, wt.branch)
2354
return b.create_checkout(relpath, lightweight=True)
2356
def assertIsDirectory(self, relpath, transport):
2357
"""Assert that relpath within transport is a directory.
2359
This may not be possible on all transports; in that case it propagates
2360
a TransportNotPossible.
2363
mode = transport.stat(relpath).st_mode
2364
except errors.NoSuchFile:
2365
self.fail("path %s is not a directory; no such file"
2367
if not stat.S_ISDIR(mode):
2368
self.fail("path %s is not a directory; has mode %#o"
2371
def assertTreesEqual(self, left, right):
2372
"""Check that left and right have the same content and properties."""
2373
# we use a tree delta to check for equality of the content, and we
2374
# manually check for equality of other things such as the parents list.
2375
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2376
differences = left.changes_from(right)
2377
self.assertFalse(differences.has_changed(),
2378
"Trees %r and %r are different: %r" % (left, right, differences))
2381
super(TestCaseWithTransport, self).setUp()
2382
self.__vfs_server = None
2385
class ChrootedTestCase(TestCaseWithTransport):
2386
"""A support class that provides readonly urls outside the local namespace.
2388
This is done by checking if self.transport_server is a MemoryServer. if it
2389
is then we are chrooted already, if it is not then an HttpServer is used
2392
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2393
be used without needed to redo it when a different
2394
subclass is in use ?
2398
super(ChrootedTestCase, self).setUp()
2399
if not self.vfs_transport_factory == MemoryServer:
2400
self.transport_readonly_server = HttpServer
2403
def condition_id_re(pattern):
2404
"""Create a condition filter which performs a re check on a test's id.
2406
:param pattern: A regular expression string.
2407
:return: A callable that returns True if the re matches.
2409
filter_re = re.compile(pattern)
2410
def condition(test):
2412
return filter_re.search(test_id)
2416
def condition_isinstance(klass_or_klass_list):
2417
"""Create a condition filter which returns isinstance(param, klass).
2419
:return: A callable which when called with one parameter obj return the
2420
result of isinstance(obj, klass_or_klass_list).
2423
return isinstance(obj, klass_or_klass_list)
2427
def condition_id_in_list(id_list):
2428
"""Create a condition filter which verify that test's id in a list.
2430
:param id_list: A TestIdList object.
2431
:return: A callable that returns True if the test's id appears in the list.
2433
def condition(test):
2434
return id_list.includes(test.id())
2438
def condition_id_startswith(starts):
2439
"""Create a condition filter verifying that test's id starts with a string.
2441
:param starts: A list of string.
2442
:return: A callable that returns True if the test's id starts with one of
2445
def condition(test):
2446
for start in starts:
2447
if test.id().startswith(start):
2453
def exclude_tests_by_condition(suite, condition):
2454
"""Create a test suite which excludes some tests from suite.
2456
:param suite: The suite to get tests from.
2457
:param condition: A callable whose result evaluates True when called with a
2458
test case which should be excluded from the result.
2459
:return: A suite which contains the tests found in suite that fail
2463
for test in iter_suite_tests(suite):
2464
if not condition(test):
2466
return TestUtil.TestSuite(result)
2469
def filter_suite_by_condition(suite, condition):
2470
"""Create a test suite by filtering another one.
2472
:param suite: The source suite.
2473
:param condition: A callable whose result evaluates True when called with a
2474
test case which should be included in the result.
2475
:return: A suite which contains the tests found in suite that pass
2479
for test in iter_suite_tests(suite):
2482
return TestUtil.TestSuite(result)
2485
def filter_suite_by_re(suite, pattern):
2486
"""Create a test suite by filtering another one.
2488
:param suite: the source suite
2489
:param pattern: pattern that names must match
2490
:returns: the newly created suite
2492
condition = condition_id_re(pattern)
2493
result_suite = filter_suite_by_condition(suite, condition)
2497
def filter_suite_by_id_list(suite, test_id_list):
2498
"""Create a test suite by filtering another one.
2500
:param suite: The source suite.
2501
:param test_id_list: A list of the test ids to keep as strings.
2502
:returns: the newly created suite
2504
condition = condition_id_in_list(test_id_list)
2505
result_suite = filter_suite_by_condition(suite, condition)
2509
def filter_suite_by_id_startswith(suite, start):
2510
"""Create a test suite by filtering another one.
2512
:param suite: The source suite.
2513
:param start: A list of string the test id must start with one of.
2514
:returns: the newly created suite
2516
condition = condition_id_startswith(start)
2517
result_suite = filter_suite_by_condition(suite, condition)
2521
def exclude_tests_by_re(suite, pattern):
2522
"""Create a test suite which excludes some tests from suite.
2524
:param suite: The suite to get tests from.
2525
:param pattern: A regular expression string. Test ids that match this
2526
pattern will be excluded from the result.
2527
:return: A TestSuite that contains all the tests from suite without the
2528
tests that matched pattern. The order of tests is the same as it was in
2531
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2534
def preserve_input(something):
2535
"""A helper for performing test suite transformation chains.
2537
:param something: Anything you want to preserve.
2543
def randomize_suite(suite):
2544
"""Return a new TestSuite with suite's tests in random order.
2546
The tests in the input suite are flattened into a single suite in order to
2547
accomplish this. Any nested TestSuites are removed to provide global
2550
tests = list(iter_suite_tests(suite))
2551
random.shuffle(tests)
2552
return TestUtil.TestSuite(tests)
2555
def split_suite_by_condition(suite, condition):
2556
"""Split a test suite into two by a condition.
2558
:param suite: The suite to split.
2559
:param condition: The condition to match on. Tests that match this
2560
condition are returned in the first test suite, ones that do not match
2561
are in the second suite.
2562
:return: A tuple of two test suites, where the first contains tests from
2563
suite matching the condition, and the second contains the remainder
2564
from suite. The order within each output suite is the same as it was in
2569
for test in iter_suite_tests(suite):
2571
matched.append(test)
2573
did_not_match.append(test)
2574
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2577
def split_suite_by_re(suite, pattern):
2578
"""Split a test suite into two by a regular expression.
2580
:param suite: The suite to split.
2581
:param pattern: A regular expression string. Test ids that match this
2582
pattern will be in the first test suite returned, and the others in the
2583
second test suite returned.
2584
:return: A tuple of two test suites, where the first contains tests from
2585
suite matching pattern, and the second contains the remainder from
2586
suite. The order within each output suite is the same as it was in
2589
return split_suite_by_condition(suite, condition_id_re(pattern))
2592
def run_suite(suite, name='test', verbose=False, pattern=".*",
2593
stop_on_failure=False,
2594
transport=None, lsprof_timed=None, bench_history=None,
2595
matching_tests_first=None,
2598
exclude_pattern=None,
2601
"""Run a test suite for bzr selftest.
2603
:param runner_class: The class of runner to use. Must support the
2604
constructor arguments passed by run_suite which are more than standard
2606
:return: A boolean indicating success.
2608
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2613
if runner_class is None:
2614
runner_class = TextTestRunner
2615
runner = runner_class(stream=sys.stdout,
2617
verbosity=verbosity,
2618
bench_history=bench_history,
2619
list_only=list_only,
2621
runner.stop_on_failure=stop_on_failure
2622
# Initialise the random number generator and display the seed used.
2623
# We convert the seed to a long to make it reuseable across invocations.
2624
random_order = False
2625
if random_seed is not None:
2627
if random_seed == "now":
2628
random_seed = long(time.time())
2630
# Convert the seed to a long if we can
2632
random_seed = long(random_seed)
2635
runner.stream.writeln("Randomizing test order using seed %s\n" %
2637
random.seed(random_seed)
2638
# Customise the list of tests if requested
2639
if exclude_pattern is not None:
2640
suite = exclude_tests_by_re(suite, exclude_pattern)
2642
order_changer = randomize_suite
2644
order_changer = preserve_input
2645
if pattern != '.*' or random_order:
2646
if matching_tests_first:
2647
suites = map(order_changer, split_suite_by_re(suite, pattern))
2648
suite = TestUtil.TestSuite(suites)
2650
suite = order_changer(filter_suite_by_re(suite, pattern))
2652
result = runner.run(suite)
2655
return result.wasStrictlySuccessful()
2657
return result.wasSuccessful()
2660
# Controlled by "bzr selftest -E=..." option
2661
selftest_debug_flags = set()
2664
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2666
test_suite_factory=None,
2669
matching_tests_first=None,
2672
exclude_pattern=None,
2679
"""Run the whole test suite under the enhanced runner"""
2680
# XXX: Very ugly way to do this...
2681
# Disable warning about old formats because we don't want it to disturb
2682
# any blackbox tests.
2683
from bzrlib import repository
2684
repository._deprecation_warning_done = True
2686
global default_transport
2687
if transport is None:
2688
transport = default_transport
2689
old_transport = default_transport
2690
default_transport = transport
2691
global selftest_debug_flags
2692
old_debug_flags = selftest_debug_flags
2693
if debug_flags is not None:
2694
selftest_debug_flags = set(debug_flags)
2696
if load_list is None:
2699
keep_only = load_test_id_list(load_list)
2700
if test_suite_factory is None:
2701
suite = test_suite(keep_only, starting_with)
2703
suite = test_suite_factory()
2704
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2705
stop_on_failure=stop_on_failure,
2706
transport=transport,
2707
lsprof_timed=lsprof_timed,
2708
bench_history=bench_history,
2709
matching_tests_first=matching_tests_first,
2710
list_only=list_only,
2711
random_seed=random_seed,
2712
exclude_pattern=exclude_pattern,
2714
runner_class=runner_class,
2717
default_transport = old_transport
2718
selftest_debug_flags = old_debug_flags
2721
def load_test_id_list(file_name):
2722
"""Load a test id list from a text file.
2724
The format is one test id by line. No special care is taken to impose
2725
strict rules, these test ids are used to filter the test suite so a test id
2726
that do not match an existing test will do no harm. This allows user to add
2727
comments, leave blank lines, etc.
2731
ftest = open(file_name, 'rt')
2733
if e.errno != errno.ENOENT:
2736
raise errors.NoSuchFile(file_name)
2738
for test_name in ftest.readlines():
2739
test_list.append(test_name.strip())
2744
def suite_matches_id_list(test_suite, id_list):
2745
"""Warns about tests not appearing or appearing more than once.
2747
:param test_suite: A TestSuite object.
2748
:param test_id_list: The list of test ids that should be found in
2751
:return: (absents, duplicates) absents is a list containing the test found
2752
in id_list but not in test_suite, duplicates is a list containing the
2753
test found multiple times in test_suite.
2755
When using a prefined test id list, it may occurs that some tests do not
2756
exist anymore or that some tests use the same id. This function warns the
2757
tester about potential problems in his workflow (test lists are volatile)
2758
or in the test suite itself (using the same id for several tests does not
2759
help to localize defects).
2761
# Build a dict counting id occurrences
2763
for test in iter_suite_tests(test_suite):
2765
tests[id] = tests.get(id, 0) + 1
2770
occurs = tests.get(id, 0)
2772
not_found.append(id)
2774
duplicates.append(id)
2776
return not_found, duplicates
2779
class TestIdList(object):
2780
"""Test id list to filter a test suite.
2782
Relying on the assumption that test ids are built as:
2783
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2784
notation, this class offers methods to :
2785
- avoid building a test suite for modules not refered to in the test list,
2786
- keep only the tests listed from the module test suite.
2789
def __init__(self, test_id_list):
2790
# When a test suite needs to be filtered against us we compare test ids
2791
# for equality, so a simple dict offers a quick and simple solution.
2792
self.tests = dict().fromkeys(test_id_list, True)
2794
# While unittest.TestCase have ids like:
2795
# <module>.<class>.<method>[(<param+)],
2796
# doctest.DocTestCase can have ids like:
2799
# <module>.<function>
2800
# <module>.<class>.<method>
2802
# Since we can't predict a test class from its name only, we settle on
2803
# a simple constraint: a test id always begins with its module name.
2806
for test_id in test_id_list:
2807
parts = test_id.split('.')
2808
mod_name = parts.pop(0)
2809
modules[mod_name] = True
2811
mod_name += '.' + part
2812
modules[mod_name] = True
2813
self.modules = modules
2815
def refers_to(self, module_name):
2816
"""Is there tests for the module or one of its sub modules."""
2817
return self.modules.has_key(module_name)
2819
def includes(self, test_id):
2820
return self.tests.has_key(test_id)
2823
class TestPrefixAliasRegistry(registry.Registry):
2824
"""A registry for test prefix aliases.
2826
This helps implement shorcuts for the --starting-with selftest
2827
option. Overriding existing prefixes is not allowed but not fatal (a
2828
warning will be emitted).
2831
def register(self, key, obj, help=None, info=None,
2832
override_existing=False):
2833
"""See Registry.register.
2835
Trying to override an existing alias causes a warning to be emitted,
2836
not a fatal execption.
2839
super(TestPrefixAliasRegistry, self).register(
2840
key, obj, help=help, info=info, override_existing=False)
2842
actual = self.get(key)
2843
note('Test prefix alias %s is already used for %s, ignoring %s'
2844
% (key, actual, obj))
2846
def resolve_alias(self, id_start):
2847
"""Replace the alias by the prefix in the given string.
2849
Using an unknown prefix is an error to help catching typos.
2851
parts = id_start.split('.')
2853
parts[0] = self.get(parts[0])
2855
raise errors.BzrCommandError(
2856
'%s is not a known test prefix alias' % parts[0])
2857
return '.'.join(parts)
2860
test_prefix_alias_registry = TestPrefixAliasRegistry()
2861
"""Registry of test prefix aliases."""
2864
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2865
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2866
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2868
# Obvious higest levels prefixes, feel free to add your own via a plugin
2869
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2870
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2871
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2872
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2873
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2876
def test_suite(keep_only=None, starting_with=None):
2877
"""Build and return TestSuite for the whole of bzrlib.
2879
:param keep_only: A list of test ids limiting the suite returned.
2881
:param starting_with: An id limiting the suite returned to the tests
2884
This function can be replaced if you need to change the default test
2885
suite on a global basis, but it is not encouraged.
2889
'bzrlib.tests.blackbox',
2890
'bzrlib.tests.branch_implementations',
2891
'bzrlib.tests.bzrdir_implementations',
2892
'bzrlib.tests.commands',
2893
'bzrlib.tests.interrepository_implementations',
2894
'bzrlib.tests.intertree_implementations',
2895
'bzrlib.tests.inventory_implementations',
2896
'bzrlib.tests.per_interbranch',
2897
'bzrlib.tests.per_lock',
2898
'bzrlib.tests.per_repository',
2899
'bzrlib.tests.per_repository_reference',
2900
'bzrlib.tests.test__dirstate_helpers',
2901
'bzrlib.tests.test__walkdirs_win32',
2902
'bzrlib.tests.test_ancestry',
2903
'bzrlib.tests.test_annotate',
2904
'bzrlib.tests.test_api',
2905
'bzrlib.tests.test_atomicfile',
2906
'bzrlib.tests.test_bad_files',
2907
'bzrlib.tests.test_bisect_multi',
2908
'bzrlib.tests.test_branch',
2909
'bzrlib.tests.test_branchbuilder',
2910
'bzrlib.tests.test_btree_index',
2911
'bzrlib.tests.test_bugtracker',
2912
'bzrlib.tests.test_bundle',
2913
'bzrlib.tests.test_bzrdir',
2914
'bzrlib.tests.test_cache_utf8',
2915
'bzrlib.tests.test_clean_tree',
2916
'bzrlib.tests.test_chunk_writer',
2917
'bzrlib.tests.test__chunks_to_lines',
2918
'bzrlib.tests.test_commands',
2919
'bzrlib.tests.test_commit',
2920
'bzrlib.tests.test_commit_merge',
2921
'bzrlib.tests.test_config',
2922
'bzrlib.tests.test_conflicts',
2923
'bzrlib.tests.test_counted_lock',
2924
'bzrlib.tests.test_decorators',
2925
'bzrlib.tests.test_delta',
2926
'bzrlib.tests.test_debug',
2927
'bzrlib.tests.test_deprecated_graph',
2928
'bzrlib.tests.test_diff',
2929
'bzrlib.tests.test_directory_service',
2930
'bzrlib.tests.test_dirstate',
2931
'bzrlib.tests.test_email_message',
2932
'bzrlib.tests.test_errors',
2933
'bzrlib.tests.test_export',
2934
'bzrlib.tests.test_extract',
2935
'bzrlib.tests.test_fetch',
2936
'bzrlib.tests.test_fifo_cache',
2937
'bzrlib.tests.test_ftp_transport',
2938
'bzrlib.tests.test_foreign',
2939
'bzrlib.tests.test_generate_docs',
2940
'bzrlib.tests.test_generate_ids',
2941
'bzrlib.tests.test_globbing',
2942
'bzrlib.tests.test_gpg',
2943
'bzrlib.tests.test_graph',
2944
'bzrlib.tests.test_hashcache',
2945
'bzrlib.tests.test_help',
2946
'bzrlib.tests.test_hooks',
2947
'bzrlib.tests.test_http',
2948
'bzrlib.tests.test_http_implementations',
2949
'bzrlib.tests.test_http_response',
2950
'bzrlib.tests.test_https_ca_bundle',
2951
'bzrlib.tests.test_identitymap',
2952
'bzrlib.tests.test_ignores',
2953
'bzrlib.tests.test_index',
2954
'bzrlib.tests.test_info',
2955
'bzrlib.tests.test_inv',
2956
'bzrlib.tests.test_knit',
2957
'bzrlib.tests.test_lazy_import',
2958
'bzrlib.tests.test_lazy_regex',
2959
'bzrlib.tests.test_lockable_files',
2960
'bzrlib.tests.test_lockdir',
2961
'bzrlib.tests.test_log',
2962
'bzrlib.tests.test_lru_cache',
2963
'bzrlib.tests.test_lsprof',
2964
'bzrlib.tests.test_mail_client',
2965
'bzrlib.tests.test_memorytree',
2966
'bzrlib.tests.test_merge',
2967
'bzrlib.tests.test_merge3',
2968
'bzrlib.tests.test_merge_core',
2969
'bzrlib.tests.test_merge_directive',
2970
'bzrlib.tests.test_missing',
2971
'bzrlib.tests.test_msgeditor',
2972
'bzrlib.tests.test_multiparent',
2973
'bzrlib.tests.test_mutabletree',
2974
'bzrlib.tests.test_nonascii',
2975
'bzrlib.tests.test_options',
2976
'bzrlib.tests.test_osutils',
2977
'bzrlib.tests.test_osutils_encodings',
2978
'bzrlib.tests.test_pack',
2979
'bzrlib.tests.test_pack_repository',
2980
'bzrlib.tests.test_patch',
2981
'bzrlib.tests.test_patches',
2982
'bzrlib.tests.test_permissions',
2983
'bzrlib.tests.test_plugins',
2984
'bzrlib.tests.test_progress',
2985
'bzrlib.tests.test_read_bundle',
2986
'bzrlib.tests.test_reconcile',
2987
'bzrlib.tests.test_reconfigure',
2988
'bzrlib.tests.test_registry',
2989
'bzrlib.tests.test_remote',
2990
'bzrlib.tests.test_repository',
2991
'bzrlib.tests.test_revert',
2992
'bzrlib.tests.test_revision',
2993
'bzrlib.tests.test_revisionspec',
2994
'bzrlib.tests.test_revisiontree',
2995
'bzrlib.tests.test_rio',
2996
'bzrlib.tests.test_rules',
2997
'bzrlib.tests.test_sampler',
2998
'bzrlib.tests.test_selftest',
2999
'bzrlib.tests.test_setup',
3000
'bzrlib.tests.test_sftp_transport',
3001
'bzrlib.tests.test_shelf',
3002
'bzrlib.tests.test_shelf_ui',
3003
'bzrlib.tests.test_smart',
3004
'bzrlib.tests.test_smart_add',
3005
'bzrlib.tests.test_smart_request',
3006
'bzrlib.tests.test_smart_transport',
3007
'bzrlib.tests.test_smtp_connection',
3008
'bzrlib.tests.test_source',
3009
'bzrlib.tests.test_ssh_transport',
3010
'bzrlib.tests.test_status',
3011
'bzrlib.tests.test_store',
3012
'bzrlib.tests.test_strace',
3013
'bzrlib.tests.test_subsume',
3014
'bzrlib.tests.test_switch',
3015
'bzrlib.tests.test_symbol_versioning',
3016
'bzrlib.tests.test_tag',
3017
'bzrlib.tests.test_testament',
3018
'bzrlib.tests.test_textfile',
3019
'bzrlib.tests.test_textmerge',
3020
'bzrlib.tests.test_timestamp',
3021
'bzrlib.tests.test_trace',
3022
'bzrlib.tests.test_transactions',
3023
'bzrlib.tests.test_transform',
3024
'bzrlib.tests.test_transport',
3025
'bzrlib.tests.test_transport_implementations',
3026
'bzrlib.tests.test_transport_log',
3027
'bzrlib.tests.test_tree',
3028
'bzrlib.tests.test_treebuilder',
3029
'bzrlib.tests.test_tsort',
3030
'bzrlib.tests.test_tuned_gzip',
3031
'bzrlib.tests.test_ui',
3032
'bzrlib.tests.test_uncommit',
3033
'bzrlib.tests.test_upgrade',
3034
'bzrlib.tests.test_upgrade_stacked',
3035
'bzrlib.tests.test_urlutils',
3036
'bzrlib.tests.test_version',
3037
'bzrlib.tests.test_version_info',
3038
'bzrlib.tests.test_versionedfile',
3039
'bzrlib.tests.test_weave',
3040
'bzrlib.tests.test_whitebox',
3041
'bzrlib.tests.test_win32utils',
3042
'bzrlib.tests.test_workingtree',
3043
'bzrlib.tests.test_workingtree_4',
3044
'bzrlib.tests.test_wsgi',
3045
'bzrlib.tests.test_xml',
3046
'bzrlib.tests.tree_implementations',
3047
'bzrlib.tests.workingtree_implementations',
3048
'bzrlib.util.tests.test_bencode',
3051
loader = TestUtil.TestLoader()
3054
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3055
for start in starting_with]
3056
# We take precedence over keep_only because *at loading time* using
3057
# both options means we will load less tests for the same final result.
3058
def interesting_module(name):
3059
for start in starting_with:
3061
# Either the module name starts with the specified string
3062
name.startswith(start)
3063
# or it may contain tests starting with the specified string
3064
or start.startswith(name)
3068
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3070
elif keep_only is not None:
3071
id_filter = TestIdList(keep_only)
3072
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3073
def interesting_module(name):
3074
return id_filter.refers_to(name)
3077
loader = TestUtil.TestLoader()
3078
def interesting_module(name):
3079
# No filtering, all modules are interesting
3082
suite = loader.suiteClass()
3084
# modules building their suite with loadTestsFromModuleNames
3085
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3087
modules_to_doctest = [
3089
'bzrlib.branchbuilder',
3092
'bzrlib.iterablefile',
3096
'bzrlib.symbol_versioning',
3099
'bzrlib.version_info_formats.format_custom',
3102
for mod in modules_to_doctest:
3103
if not interesting_module(mod):
3104
# No tests to keep here, move along
3107
# note that this really does mean "report only" -- doctest
3108
# still runs the rest of the examples
3109
doc_suite = doctest.DocTestSuite(mod,
3110
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3111
except ValueError, e:
3112
print '**failed to get doctest for: %s\n%s' % (mod, e)
3114
if len(doc_suite._tests) == 0:
3115
raise errors.BzrError("no doctests found in %s" % (mod,))
3116
suite.addTest(doc_suite)
3118
default_encoding = sys.getdefaultencoding()
3119
for name, plugin in bzrlib.plugin.plugins().items():
3120
if not interesting_module(plugin.module.__name__):
3122
plugin_suite = plugin.test_suite()
3123
# We used to catch ImportError here and turn it into just a warning,
3124
# but really if you don't have --no-plugins this should be a failure.
3125
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3126
if plugin_suite is None:
3127
plugin_suite = plugin.load_plugin_tests(loader)
3128
if plugin_suite is not None:
3129
suite.addTest(plugin_suite)
3130
if default_encoding != sys.getdefaultencoding():
3131
bzrlib.trace.warning(
3132
'Plugin "%s" tried to reset default encoding to: %s', name,
3133
sys.getdefaultencoding())
3135
sys.setdefaultencoding(default_encoding)
3138
suite = filter_suite_by_id_startswith(suite, starting_with)
3140
if keep_only is not None:
3141
# Now that the referred modules have loaded their tests, keep only the
3143
suite = filter_suite_by_id_list(suite, id_filter)
3144
# Do some sanity checks on the id_list filtering
3145
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3147
# The tester has used both keep_only and starting_with, so he is
3148
# already aware that some tests are excluded from the list, there
3149
# is no need to tell him which.
3152
# Some tests mentioned in the list are not in the test suite. The
3153
# list may be out of date, report to the tester.
3154
for id in not_found:
3155
bzrlib.trace.warning('"%s" not found in the test suite', id)
3156
for id in duplicates:
3157
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3162
def multiply_scenarios(scenarios_left, scenarios_right):
3163
"""Multiply two sets of scenarios.
3165
:returns: the cartesian product of the two sets of scenarios, that is
3166
a scenario for every possible combination of a left scenario and a
3170
('%s,%s' % (left_name, right_name),
3171
dict(left_dict.items() + right_dict.items()))
3172
for left_name, left_dict in scenarios_left
3173
for right_name, right_dict in scenarios_right]
3176
def multiply_tests(tests, scenarios, result):
3177
"""Multiply tests_list by scenarios into result.
3179
This is the core workhorse for test parameterisation.
3181
Typically the load_tests() method for a per-implementation test suite will
3182
call multiply_tests and return the result.
3184
:param tests: The tests to parameterise.
3185
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3186
scenario_param_dict).
3187
:param result: A TestSuite to add created tests to.
3189
This returns the passed in result TestSuite with the cross product of all
3190
the tests repeated once for each scenario. Each test is adapted by adding
3191
the scenario name at the end of its id(), and updating the test object's
3192
__dict__ with the scenario_param_dict.
3194
>>> r = multiply_tests(
3195
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3196
... [('one', dict(param=1)),
3197
... ('two', dict(param=2))],
3199
>>> tests = list(iter_suite_tests(r))
3203
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3209
for test in iter_suite_tests(tests):
3210
apply_scenarios(test, scenarios, result)
3214
def apply_scenarios(test, scenarios, result):
3215
"""Apply the scenarios in scenarios to test and add to result.
3217
:param test: The test to apply scenarios to.
3218
:param scenarios: An iterable of scenarios to apply to test.
3220
:seealso: apply_scenario
3222
for scenario in scenarios:
3223
result.addTest(apply_scenario(test, scenario))
3227
def apply_scenario(test, scenario):
3228
"""Copy test and apply scenario to it.
3230
:param test: A test to adapt.
3231
:param scenario: A tuple describing the scenarion.
3232
The first element of the tuple is the new test id.
3233
The second element is a dict containing attributes to set on the
3235
:return: The adapted test.
3237
new_id = "%s(%s)" % (test.id(), scenario[0])
3238
new_test = clone_test(test, new_id)
3239
for name, value in scenario[1].items():
3240
setattr(new_test, name, value)
3244
def clone_test(test, new_id):
3245
"""Clone a test giving it a new id.
3247
:param test: The test to clone.
3248
:param new_id: The id to assign to it.
3249
:return: The new test.
3251
from copy import deepcopy
3252
new_test = deepcopy(test)
3253
new_test.id = lambda: new_id
3257
def _rmtree_temp_dir(dirname):
3258
# If LANG=C we probably have created some bogus paths
3259
# which rmtree(unicode) will fail to delete
3260
# so make sure we are using rmtree(str) to delete everything
3261
# except on win32, where rmtree(str) will fail
3262
# since it doesn't have the property of byte-stream paths
3263
# (they are either ascii or mbcs)
3264
if sys.platform == 'win32':
3265
# make sure we are using the unicode win32 api
3266
dirname = unicode(dirname)
3268
dirname = dirname.encode(sys.getfilesystemencoding())
3270
osutils.rmtree(dirname)
3272
if sys.platform == 'win32' and e.errno == errno.EACCES:
3273
sys.stderr.write(('Permission denied: '
3274
'unable to remove testing dir '
3275
'%s\n' % os.path.basename(dirname)))
3280
class Feature(object):
3281
"""An operating system Feature."""
3284
self._available = None
3286
def available(self):
3287
"""Is the feature available?
3289
:return: True if the feature is available.
3291
if self._available is None:
3292
self._available = self._probe()
3293
return self._available
3296
"""Implement this method in concrete features.
3298
:return: True if the feature is available.
3300
raise NotImplementedError
3303
if getattr(self, 'feature_name', None):
3304
return self.feature_name()
3305
return self.__class__.__name__
3308
class _SymlinkFeature(Feature):
3311
return osutils.has_symlinks()
3313
def feature_name(self):
3316
SymlinkFeature = _SymlinkFeature()
3319
class _HardlinkFeature(Feature):
3322
return osutils.has_hardlinks()
3324
def feature_name(self):
3327
HardlinkFeature = _HardlinkFeature()
3330
class _OsFifoFeature(Feature):
3333
return getattr(os, 'mkfifo', None)
3335
def feature_name(self):
3336
return 'filesystem fifos'
3338
OsFifoFeature = _OsFifoFeature()
3341
class _UnicodeFilenameFeature(Feature):
3342
"""Does the filesystem support Unicode filenames?"""
3346
# Check for character combinations unlikely to be covered by any
3347
# single non-unicode encoding. We use the characters
3348
# - greek small letter alpha (U+03B1) and
3349
# - braille pattern dots-123456 (U+283F).
3350
os.stat(u'\u03b1\u283f')
3351
except UnicodeEncodeError:
3353
except (IOError, OSError):
3354
# The filesystem allows the Unicode filename but the file doesn't
3358
# The filesystem allows the Unicode filename and the file exists,
3362
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3365
def probe_unicode_in_user_encoding():
3366
"""Try to encode several unicode strings to use in unicode-aware tests.
3367
Return first successfull match.
3369
:return: (unicode value, encoded plain string value) or (None, None)
3371
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3372
for uni_val in possible_vals:
3374
str_val = uni_val.encode(osutils.get_user_encoding())
3375
except UnicodeEncodeError:
3376
# Try a different character
3379
return uni_val, str_val
3383
def probe_bad_non_ascii(encoding):
3384
"""Try to find [bad] character with code [128..255]
3385
that cannot be decoded to unicode in some encoding.
3386
Return None if all non-ascii characters is valid
3389
for i in xrange(128, 256):
3392
char.decode(encoding)
3393
except UnicodeDecodeError:
3398
class _FTPServerFeature(Feature):
3399
"""Some tests want an FTP Server, check if one is available.
3401
Right now, the only way this is available is if 'medusa' is installed.
3402
http://www.amk.ca/python/code/medusa.html
3407
import bzrlib.tests.ftp_server
3412
def feature_name(self):
3416
FTPServerFeature = _FTPServerFeature()
3419
class _HTTPSServerFeature(Feature):
3420
"""Some tests want an https Server, check if one is available.
3422
Right now, the only way this is available is under python2.6 which provides
3433
def feature_name(self):
3434
return 'HTTPSServer'
3437
HTTPSServerFeature = _HTTPSServerFeature()
3440
class _UnicodeFilename(Feature):
3441
"""Does the filesystem support Unicode filenames?"""
3446
except UnicodeEncodeError:
3448
except (IOError, OSError):
3449
# The filesystem allows the Unicode filename but the file doesn't
3453
# The filesystem allows the Unicode filename and the file exists,
3457
UnicodeFilename = _UnicodeFilename()
3460
class _UTF8Filesystem(Feature):
3461
"""Is the filesystem UTF-8?"""
3464
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3468
UTF8Filesystem = _UTF8Filesystem()
3471
class _CaseInsCasePresFilenameFeature(Feature):
3472
"""Is the file-system case insensitive, but case-preserving?"""
3475
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3477
# first check truly case-preserving for created files, then check
3478
# case insensitive when opening existing files.
3479
name = osutils.normpath(name)
3480
base, rel = osutils.split(name)
3481
found_rel = osutils.canonical_relpath(base, name)
3482
return (found_rel == rel
3483
and os.path.isfile(name.upper())
3484
and os.path.isfile(name.lower()))
3489
def feature_name(self):
3490
return "case-insensitive case-preserving filesystem"
3492
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3495
class _CaseInsensitiveFilesystemFeature(Feature):
3496
"""Check if underlying filesystem is case-insensitive but *not* case
3499
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3500
# more likely to be case preserving, so this case is rare.
3503
if CaseInsCasePresFilenameFeature.available():
3506
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3507
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3508
TestCaseWithMemoryTransport.TEST_ROOT = root
3510
root = TestCaseWithMemoryTransport.TEST_ROOT
3511
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3513
name_a = osutils.pathjoin(tdir, 'a')
3514
name_A = osutils.pathjoin(tdir, 'A')
3516
result = osutils.isdir(name_A)
3517
_rmtree_temp_dir(tdir)
3520
def feature_name(self):
3521
return 'case-insensitive filesystem'
3523
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
