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 assertLength(self, length, obj_with_len):
906
"""Assert that obj_with_len is of length length."""
907
if len(obj_with_len) != length:
908
self.fail("Incorrect length: wanted %d, got %d for %r" % (
909
length, len(obj_with_len), obj_with_len))
911
def assertPositive(self, val):
912
"""Assert that val is greater than 0."""
913
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
915
def assertNegative(self, val):
916
"""Assert that val is less than 0."""
917
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
919
def assertStartsWith(self, s, prefix):
920
if not s.startswith(prefix):
921
raise AssertionError('string %r does not start with %r' % (s, prefix))
923
def assertEndsWith(self, s, suffix):
924
"""Asserts that s ends with suffix."""
925
if not s.endswith(suffix):
926
raise AssertionError('string %r does not end with %r' % (s, suffix))
928
def assertContainsRe(self, haystack, needle_re, flags=0):
929
"""Assert that a contains something matching a regular expression."""
930
if not re.search(needle_re, haystack, flags):
931
if '\n' in haystack or len(haystack) > 60:
932
# a long string, format it in a more readable way
933
raise AssertionError(
934
'pattern "%s" not found in\n"""\\\n%s"""\n'
935
% (needle_re, haystack))
937
raise AssertionError('pattern "%s" not found in "%s"'
938
% (needle_re, haystack))
940
def assertNotContainsRe(self, haystack, needle_re, flags=0):
941
"""Assert that a does not match a regular expression"""
942
if re.search(needle_re, haystack, flags):
943
raise AssertionError('pattern "%s" found in "%s"'
944
% (needle_re, haystack))
946
def assertSubset(self, sublist, superlist):
947
"""Assert that every entry in sublist is present in superlist."""
948
missing = set(sublist) - set(superlist)
950
raise AssertionError("value(s) %r not present in container %r" %
951
(missing, superlist))
953
def assertListRaises(self, excClass, func, *args, **kwargs):
954
"""Fail unless excClass is raised when the iterator from func is used.
956
Many functions can return generators this makes sure
957
to wrap them in a list() call to make sure the whole generator
958
is run, and that the proper exception is raised.
961
list(func(*args, **kwargs))
965
if getattr(excClass,'__name__', None) is not None:
966
excName = excClass.__name__
968
excName = str(excClass)
969
raise self.failureException, "%s not raised" % excName
971
def assertRaises(self, excClass, callableObj, *args, **kwargs):
972
"""Assert that a callable raises a particular exception.
974
:param excClass: As for the except statement, this may be either an
975
exception class, or a tuple of classes.
976
:param callableObj: A callable, will be passed ``*args`` and
979
Returns the exception so that you can examine it.
982
callableObj(*args, **kwargs)
986
if getattr(excClass,'__name__', None) is not None:
987
excName = excClass.__name__
990
excName = str(excClass)
991
raise self.failureException, "%s not raised" % excName
993
def assertIs(self, left, right, message=None):
994
if not (left is right):
995
if message is not None:
996
raise AssertionError(message)
998
raise AssertionError("%r is not %r." % (left, right))
1000
def assertIsNot(self, left, right, message=None):
1002
if message is not None:
1003
raise AssertionError(message)
1005
raise AssertionError("%r is %r." % (left, right))
1007
def assertTransportMode(self, transport, path, mode):
1008
"""Fail if a path does not have mode mode.
1010
If modes are not supported on this transport, the assertion is ignored.
1012
if not transport._can_roundtrip_unix_modebits():
1014
path_stat = transport.stat(path)
1015
actual_mode = stat.S_IMODE(path_stat.st_mode)
1016
self.assertEqual(mode, actual_mode,
1017
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1019
def assertIsSameRealPath(self, path1, path2):
1020
"""Fail if path1 and path2 points to different files"""
1021
self.assertEqual(osutils.realpath(path1),
1022
osutils.realpath(path2),
1023
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1025
def assertIsInstance(self, obj, kls):
1026
"""Fail if obj is not an instance of kls"""
1027
if not isinstance(obj, kls):
1028
self.fail("%r is an instance of %s rather than %s" % (
1029
obj, obj.__class__, kls))
1031
def expectFailure(self, reason, assertion, *args, **kwargs):
1032
"""Invoke a test, expecting it to fail for the given reason.
1034
This is for assertions that ought to succeed, but currently fail.
1035
(The failure is *expected* but not *wanted*.) Please be very precise
1036
about the failure you're expecting. If a new bug is introduced,
1037
AssertionError should be raised, not KnownFailure.
1039
Frequently, expectFailure should be followed by an opposite assertion.
1042
Intended to be used with a callable that raises AssertionError as the
1043
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1045
Raises KnownFailure if the test fails. Raises AssertionError if the
1050
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1052
self.assertEqual(42, dynamic_val)
1054
This means that a dynamic_val of 54 will cause the test to raise
1055
a KnownFailure. Once math is fixed and the expectFailure is removed,
1056
only a dynamic_val of 42 will allow the test to pass. Anything other
1057
than 54 or 42 will cause an AssertionError.
1060
assertion(*args, **kwargs)
1061
except AssertionError:
1062
raise KnownFailure(reason)
1064
self.fail('Unexpected success. Should have failed: %s' % reason)
1066
def assertFileEqual(self, content, path):
1067
"""Fail if path does not contain 'content'."""
1068
self.failUnlessExists(path)
1069
f = file(path, 'rb')
1074
self.assertEqualDiff(content, s)
1076
def failUnlessExists(self, path):
1077
"""Fail unless path or paths, which may be abs or relative, exist."""
1078
if not isinstance(path, basestring):
1080
self.failUnlessExists(p)
1082
self.failUnless(osutils.lexists(path),path+" does not exist")
1084
def failIfExists(self, path):
1085
"""Fail if path or paths, which may be abs or relative, exist."""
1086
if not isinstance(path, basestring):
1088
self.failIfExists(p)
1090
self.failIf(osutils.lexists(path),path+" exists")
1092
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1093
"""A helper for callDeprecated and applyDeprecated.
1095
:param a_callable: A callable to call.
1096
:param args: The positional arguments for the callable
1097
:param kwargs: The keyword arguments for the callable
1098
:return: A tuple (warnings, result). result is the result of calling
1099
a_callable(``*args``, ``**kwargs``).
1102
def capture_warnings(msg, cls=None, stacklevel=None):
1103
# we've hooked into a deprecation specific callpath,
1104
# only deprecations should getting sent via it.
1105
self.assertEqual(cls, DeprecationWarning)
1106
local_warnings.append(msg)
1107
original_warning_method = symbol_versioning.warn
1108
symbol_versioning.set_warning_method(capture_warnings)
1110
result = a_callable(*args, **kwargs)
1112
symbol_versioning.set_warning_method(original_warning_method)
1113
return (local_warnings, result)
1115
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1116
"""Call a deprecated callable without warning the user.
1118
Note that this only captures warnings raised by symbol_versioning.warn,
1119
not other callers that go direct to the warning module.
1121
To test that a deprecated method raises an error, do something like
1124
self.assertRaises(errors.ReservedId,
1125
self.applyDeprecated,
1126
deprecated_in((1, 5, 0)),
1130
:param deprecation_format: The deprecation format that the callable
1131
should have been deprecated with. This is the same type as the
1132
parameter to deprecated_method/deprecated_function. If the
1133
callable is not deprecated with this format, an assertion error
1135
:param a_callable: A callable to call. This may be a bound method or
1136
a regular function. It will be called with ``*args`` and
1138
:param args: The positional arguments for the callable
1139
:param kwargs: The keyword arguments for the callable
1140
:return: The result of a_callable(``*args``, ``**kwargs``)
1142
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1144
expected_first_warning = symbol_versioning.deprecation_string(
1145
a_callable, deprecation_format)
1146
if len(call_warnings) == 0:
1147
self.fail("No deprecation warning generated by call to %s" %
1149
self.assertEqual(expected_first_warning, call_warnings[0])
1152
def callCatchWarnings(self, fn, *args, **kw):
1153
"""Call a callable that raises python warnings.
1155
The caller's responsible for examining the returned warnings.
1157
If the callable raises an exception, the exception is not
1158
caught and propagates up to the caller. In that case, the list
1159
of warnings is not available.
1161
:returns: ([warning_object, ...], fn_result)
1163
# XXX: This is not perfect, because it completely overrides the
1164
# warnings filters, and some code may depend on suppressing particular
1165
# warnings. It's the easiest way to insulate ourselves from -Werror,
1166
# though. -- Andrew, 20071062
1168
def _catcher(message, category, filename, lineno, file=None, line=None):
1169
# despite the name, 'message' is normally(?) a Warning subclass
1171
wlist.append(message)
1172
saved_showwarning = warnings.showwarning
1173
saved_filters = warnings.filters
1175
warnings.showwarning = _catcher
1176
warnings.filters = []
1177
result = fn(*args, **kw)
1179
warnings.showwarning = saved_showwarning
1180
warnings.filters = saved_filters
1181
return wlist, result
1183
def callDeprecated(self, expected, callable, *args, **kwargs):
1184
"""Assert that a callable is deprecated in a particular way.
1186
This is a very precise test for unusual requirements. The
1187
applyDeprecated helper function is probably more suited for most tests
1188
as it allows you to simply specify the deprecation format being used
1189
and will ensure that that is issued for the function being called.
1191
Note that this only captures warnings raised by symbol_versioning.warn,
1192
not other callers that go direct to the warning module. To catch
1193
general warnings, use callCatchWarnings.
1195
:param expected: a list of the deprecation warnings expected, in order
1196
:param callable: The callable to call
1197
:param args: The positional arguments for the callable
1198
:param kwargs: The keyword arguments for the callable
1200
call_warnings, result = self._capture_deprecation_warnings(callable,
1202
self.assertEqual(expected, call_warnings)
1205
def _startLogFile(self):
1206
"""Send bzr and test log messages to a temporary file.
1208
The file is removed as the test is torn down.
1210
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1211
self._log_file = os.fdopen(fileno, 'w+')
1212
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1213
self._log_file_name = name
1214
self.addCleanup(self._finishLogFile)
1216
def _finishLogFile(self):
1217
"""Finished with the log file.
1219
Close the file and delete it, unless setKeepLogfile was called.
1221
if self._log_file is None:
1223
bzrlib.trace.pop_log_file(self._log_memento)
1224
self._log_file.close()
1225
self._log_file = None
1226
if not self._keep_log_file:
1227
os.remove(self._log_file_name)
1228
self._log_file_name = None
1230
def setKeepLogfile(self):
1231
"""Make the logfile not be deleted when _finishLogFile is called."""
1232
self._keep_log_file = True
1234
def addCleanup(self, callable, *args, **kwargs):
1235
"""Arrange to run a callable when this case is torn down.
1237
Callables are run in the reverse of the order they are registered,
1238
ie last-in first-out.
1240
self._cleanups.append((callable, args, kwargs))
1242
def _cleanEnvironment(self):
1244
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1245
'HOME': os.getcwd(),
1246
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1247
# tests do check our impls match APPDATA
1248
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1250
'BZREMAIL': None, # may still be present in the environment
1252
'BZR_PROGRESS_BAR': None,
1254
'BZR_PLUGIN_PATH': None,
1256
'SSH_AUTH_SOCK': None,
1260
'https_proxy': None,
1261
'HTTPS_PROXY': None,
1266
# Nobody cares about these ones AFAIK. So far at
1267
# least. If you do (care), please update this comment
1271
'BZR_REMOTE_PATH': None,
1274
self.addCleanup(self._restoreEnvironment)
1275
for name, value in new_env.iteritems():
1276
self._captureVar(name, value)
1278
def _captureVar(self, name, newvalue):
1279
"""Set an environment variable, and reset it when finished."""
1280
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1282
def _restore_debug_flags(self):
1283
debug.debug_flags.clear()
1284
debug.debug_flags.update(self._preserved_debug_flags)
1286
def _restoreEnvironment(self):
1287
for name, value in self.__old_env.iteritems():
1288
osutils.set_or_unset_env(name, value)
1290
def _restoreHooks(self):
1291
for klass, (name, hooks) in self._preserved_hooks.items():
1292
setattr(klass, name, hooks)
1294
def knownFailure(self, reason):
1295
"""This test has failed for some known reason."""
1296
raise KnownFailure(reason)
1298
def _do_skip(self, result, reason):
1299
addSkip = getattr(result, 'addSkip', None)
1300
if not callable(addSkip):
1301
result.addError(self, self.exc_info())
1303
addSkip(self, reason)
1305
def run(self, result=None):
1306
if result is None: result = self.defaultTestResult()
1307
for feature in getattr(self, '_test_needs_features', []):
1308
if not feature.available():
1309
result.startTest(self)
1310
if getattr(result, 'addNotSupported', None):
1311
result.addNotSupported(self, feature)
1313
result.addSuccess(self)
1314
result.stopTest(self)
1318
result.startTest(self)
1319
absent_attr = object()
1321
method_name = getattr(self, '_testMethodName', absent_attr)
1322
if method_name is absent_attr:
1324
method_name = getattr(self, '_TestCase__testMethodName')
1325
testMethod = getattr(self, method_name)
1329
except KeyboardInterrupt:
1331
except TestSkipped, e:
1332
self._do_skip(result, e.args[0])
1336
result.addError(self, self.exc_info())
1343
except self.failureException:
1344
result.addFailure(self, self.exc_info())
1345
except TestSkipped, e:
1347
reason = "No reason given."
1350
self._do_skip(result, reason)
1351
except KeyboardInterrupt:
1354
result.addError(self, self.exc_info())
1358
except KeyboardInterrupt:
1361
result.addError(self, self.exc_info())
1363
if ok: result.addSuccess(self)
1365
result.stopTest(self)
1367
except TestNotApplicable:
1368
# Not moved from the result [yet].
1370
except KeyboardInterrupt:
1374
absent_attr = object()
1375
for attr_name in self.attrs_to_keep:
1376
attr = getattr(self, attr_name, absent_attr)
1377
if attr is not absent_attr:
1378
saved_attrs[attr_name] = attr
1379
self.__dict__ = saved_attrs
1383
self._log_contents = ''
1384
unittest.TestCase.tearDown(self)
1386
def time(self, callable, *args, **kwargs):
1387
"""Run callable and accrue the time it takes to the benchmark time.
1389
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1390
this will cause lsprofile statistics to be gathered and stored in
1393
if self._benchtime is None:
1397
if not self._gather_lsprof_in_benchmarks:
1398
return callable(*args, **kwargs)
1400
# record this benchmark
1401
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1403
self._benchcalls.append(((callable, args, kwargs), stats))
1406
self._benchtime += time.time() - start
1408
def _runCleanups(self):
1409
"""Run registered cleanup functions.
1411
This should only be called from TestCase.tearDown.
1413
# TODO: Perhaps this should keep running cleanups even if
1414
# one of them fails?
1416
# Actually pop the cleanups from the list so tearDown running
1417
# twice is safe (this happens for skipped tests).
1418
while self._cleanups:
1419
cleanup, args, kwargs = self._cleanups.pop()
1420
cleanup(*args, **kwargs)
1422
def log(self, *args):
1425
def _get_log(self, keep_log_file=False):
1426
"""Get the log from bzrlib.trace calls from this test.
1428
:param keep_log_file: When True, if the log is still a file on disk
1429
leave it as a file on disk. When False, if the log is still a file
1430
on disk, the log file is deleted and the log preserved as
1432
:return: A string containing the log.
1434
# flush the log file, to get all content
1436
if bzrlib.trace._trace_file:
1437
bzrlib.trace._trace_file.flush()
1438
if self._log_contents:
1439
# XXX: this can hardly contain the content flushed above --vila
1441
return self._log_contents
1442
if self._log_file_name is not None:
1443
logfile = open(self._log_file_name)
1445
log_contents = logfile.read()
1448
if not keep_log_file:
1449
self._log_contents = log_contents
1451
os.remove(self._log_file_name)
1453
if sys.platform == 'win32' and e.errno == errno.EACCES:
1454
sys.stderr.write(('Unable to delete log file '
1455
' %r\n' % self._log_file_name))
1460
return "DELETED log file to reduce memory footprint"
1462
def requireFeature(self, feature):
1463
"""This test requires a specific feature is available.
1465
:raises UnavailableFeature: When feature is not available.
1467
if not feature.available():
1468
raise UnavailableFeature(feature)
1470
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1472
"""Run bazaar command line, splitting up a string command line."""
1473
if isinstance(args, basestring):
1474
# shlex don't understand unicode strings,
1475
# so args should be plain string (bialix 20070906)
1476
args = list(shlex.split(str(args)))
1477
return self._run_bzr_core(args, retcode=retcode,
1478
encoding=encoding, stdin=stdin, working_dir=working_dir,
1481
def _run_bzr_core(self, args, retcode, encoding, stdin,
1483
if encoding is None:
1484
encoding = osutils.get_user_encoding()
1485
stdout = StringIOWrapper()
1486
stderr = StringIOWrapper()
1487
stdout.encoding = encoding
1488
stderr.encoding = encoding
1490
self.log('run bzr: %r', args)
1491
# FIXME: don't call into logging here
1492
handler = logging.StreamHandler(stderr)
1493
handler.setLevel(logging.INFO)
1494
logger = logging.getLogger('')
1495
logger.addHandler(handler)
1496
old_ui_factory = ui.ui_factory
1497
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1500
if working_dir is not None:
1501
cwd = osutils.getcwd()
1502
os.chdir(working_dir)
1505
result = self.apply_redirected(ui.ui_factory.stdin,
1507
bzrlib.commands.run_bzr_catch_user_errors,
1510
logger.removeHandler(handler)
1511
ui.ui_factory = old_ui_factory
1515
out = stdout.getvalue()
1516
err = stderr.getvalue()
1518
self.log('output:\n%r', out)
1520
self.log('errors:\n%r', err)
1521
if retcode is not None:
1522
self.assertEquals(retcode, result,
1523
message='Unexpected return code')
1526
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1527
working_dir=None, error_regexes=[], output_encoding=None):
1528
"""Invoke bzr, as if it were run from the command line.
1530
The argument list should not include the bzr program name - the
1531
first argument is normally the bzr command. Arguments may be
1532
passed in three ways:
1534
1- A list of strings, eg ["commit", "a"]. This is recommended
1535
when the command contains whitespace or metacharacters, or
1536
is built up at run time.
1538
2- A single string, eg "add a". This is the most convenient
1539
for hardcoded commands.
1541
This runs bzr through the interface that catches and reports
1542
errors, and with logging set to something approximating the
1543
default, so that error reporting can be checked.
1545
This should be the main method for tests that want to exercise the
1546
overall behavior of the bzr application (rather than a unit test
1547
or a functional test of the library.)
1549
This sends the stdout/stderr results into the test's log,
1550
where it may be useful for debugging. See also run_captured.
1552
:keyword stdin: A string to be used as stdin for the command.
1553
:keyword retcode: The status code the command should return;
1555
:keyword working_dir: The directory to run the command in
1556
:keyword error_regexes: A list of expected error messages. If
1557
specified they must be seen in the error output of the command.
1559
out, err = self._run_bzr_autosplit(
1564
working_dir=working_dir,
1566
for regex in error_regexes:
1567
self.assertContainsRe(err, regex)
1570
def run_bzr_error(self, error_regexes, *args, **kwargs):
1571
"""Run bzr, and check that stderr contains the supplied regexes
1573
:param error_regexes: Sequence of regular expressions which
1574
must each be found in the error output. The relative ordering
1576
:param args: command-line arguments for bzr
1577
:param kwargs: Keyword arguments which are interpreted by run_bzr
1578
This function changes the default value of retcode to be 3,
1579
since in most cases this is run when you expect bzr to fail.
1581
:return: (out, err) The actual output of running the command (in case
1582
you want to do more inspection)
1586
# Make sure that commit is failing because there is nothing to do
1587
self.run_bzr_error(['no changes to commit'],
1588
['commit', '-m', 'my commit comment'])
1589
# Make sure --strict is handling an unknown file, rather than
1590
# giving us the 'nothing to do' error
1591
self.build_tree(['unknown'])
1592
self.run_bzr_error(['Commit refused because there are unknown files'],
1593
['commit', --strict', '-m', 'my commit comment'])
1595
kwargs.setdefault('retcode', 3)
1596
kwargs['error_regexes'] = error_regexes
1597
out, err = self.run_bzr(*args, **kwargs)
1600
def run_bzr_subprocess(self, *args, **kwargs):
1601
"""Run bzr in a subprocess for testing.
1603
This starts a new Python interpreter and runs bzr in there.
1604
This should only be used for tests that have a justifiable need for
1605
this isolation: e.g. they are testing startup time, or signal
1606
handling, or early startup code, etc. Subprocess code can't be
1607
profiled or debugged so easily.
1609
:keyword retcode: The status code that is expected. Defaults to 0. If
1610
None is supplied, the status code is not checked.
1611
:keyword env_changes: A dictionary which lists changes to environment
1612
variables. A value of None will unset the env variable.
1613
The values must be strings. The change will only occur in the
1614
child, so you don't need to fix the environment after running.
1615
:keyword universal_newlines: Convert CRLF => LF
1616
:keyword allow_plugins: By default the subprocess is run with
1617
--no-plugins to ensure test reproducibility. Also, it is possible
1618
for system-wide plugins to create unexpected output on stderr,
1619
which can cause unnecessary test failures.
1621
env_changes = kwargs.get('env_changes', {})
1622
working_dir = kwargs.get('working_dir', None)
1623
allow_plugins = kwargs.get('allow_plugins', False)
1625
if isinstance(args[0], list):
1627
elif isinstance(args[0], basestring):
1628
args = list(shlex.split(args[0]))
1630
raise ValueError("passing varargs to run_bzr_subprocess")
1631
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1632
working_dir=working_dir,
1633
allow_plugins=allow_plugins)
1634
# We distinguish between retcode=None and retcode not passed.
1635
supplied_retcode = kwargs.get('retcode', 0)
1636
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1637
universal_newlines=kwargs.get('universal_newlines', False),
1640
def start_bzr_subprocess(self, process_args, env_changes=None,
1641
skip_if_plan_to_signal=False,
1643
allow_plugins=False):
1644
"""Start bzr in a subprocess for testing.
1646
This starts a new Python interpreter and runs bzr in there.
1647
This should only be used for tests that have a justifiable need for
1648
this isolation: e.g. they are testing startup time, or signal
1649
handling, or early startup code, etc. Subprocess code can't be
1650
profiled or debugged so easily.
1652
:param process_args: a list of arguments to pass to the bzr executable,
1653
for example ``['--version']``.
1654
:param env_changes: A dictionary which lists changes to environment
1655
variables. A value of None will unset the env variable.
1656
The values must be strings. The change will only occur in the
1657
child, so you don't need to fix the environment after running.
1658
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1660
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1662
:returns: Popen object for the started process.
1664
if skip_if_plan_to_signal:
1665
if not getattr(os, 'kill', None):
1666
raise TestSkipped("os.kill not available.")
1668
if env_changes is None:
1672
def cleanup_environment():
1673
for env_var, value in env_changes.iteritems():
1674
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1676
def restore_environment():
1677
for env_var, value in old_env.iteritems():
1678
osutils.set_or_unset_env(env_var, value)
1680
bzr_path = self.get_bzr_path()
1683
if working_dir is not None:
1684
cwd = osutils.getcwd()
1685
os.chdir(working_dir)
1688
# win32 subprocess doesn't support preexec_fn
1689
# so we will avoid using it on all platforms, just to
1690
# make sure the code path is used, and we don't break on win32
1691
cleanup_environment()
1692
command = [sys.executable]
1693
# frozen executables don't need the path to bzr
1694
if getattr(sys, "frozen", None) is None:
1695
command.append(bzr_path)
1696
if not allow_plugins:
1697
command.append('--no-plugins')
1698
command.extend(process_args)
1699
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1701
restore_environment()
1707
def _popen(self, *args, **kwargs):
1708
"""Place a call to Popen.
1710
Allows tests to override this method to intercept the calls made to
1711
Popen for introspection.
1713
return Popen(*args, **kwargs)
1715
def get_bzr_path(self):
1716
"""Return the path of the 'bzr' executable for this test suite."""
1717
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1718
if not os.path.isfile(bzr_path):
1719
# We are probably installed. Assume sys.argv is the right file
1720
bzr_path = sys.argv[0]
1723
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1724
universal_newlines=False, process_args=None):
1725
"""Finish the execution of process.
1727
:param process: the Popen object returned from start_bzr_subprocess.
1728
:param retcode: The status code that is expected. Defaults to 0. If
1729
None is supplied, the status code is not checked.
1730
:param send_signal: an optional signal to send to the process.
1731
:param universal_newlines: Convert CRLF => LF
1732
:returns: (stdout, stderr)
1734
if send_signal is not None:
1735
os.kill(process.pid, send_signal)
1736
out, err = process.communicate()
1738
if universal_newlines:
1739
out = out.replace('\r\n', '\n')
1740
err = err.replace('\r\n', '\n')
1742
if retcode is not None and retcode != process.returncode:
1743
if process_args is None:
1744
process_args = "(unknown args)"
1745
mutter('Output of bzr %s:\n%s', process_args, out)
1746
mutter('Error for bzr %s:\n%s', process_args, err)
1747
self.fail('Command bzr %s failed with retcode %s != %s'
1748
% (process_args, retcode, process.returncode))
1751
def check_inventory_shape(self, inv, shape):
1752
"""Compare an inventory to a list of expected names.
1754
Fail if they are not precisely equal.
1757
shape = list(shape) # copy
1758
for path, ie in inv.entries():
1759
name = path.replace('\\', '/')
1760
if ie.kind == 'directory':
1767
self.fail("expected paths not found in inventory: %r" % shape)
1769
self.fail("unexpected paths found in inventory: %r" % extras)
1771
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1772
a_callable=None, *args, **kwargs):
1773
"""Call callable with redirected std io pipes.
1775
Returns the return code."""
1776
if not callable(a_callable):
1777
raise ValueError("a_callable must be callable.")
1779
stdin = StringIO("")
1781
if getattr(self, "_log_file", None) is not None:
1782
stdout = self._log_file
1786
if getattr(self, "_log_file", None is not None):
1787
stderr = self._log_file
1790
real_stdin = sys.stdin
1791
real_stdout = sys.stdout
1792
real_stderr = sys.stderr
1797
return a_callable(*args, **kwargs)
1799
sys.stdout = real_stdout
1800
sys.stderr = real_stderr
1801
sys.stdin = real_stdin
1803
def reduceLockdirTimeout(self):
1804
"""Reduce the default lock timeout for the duration of the test, so that
1805
if LockContention occurs during a test, it does so quickly.
1807
Tests that expect to provoke LockContention errors should call this.
1809
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1811
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1812
self.addCleanup(resetTimeout)
1813
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1815
def make_utf8_encoded_stringio(self, encoding_type=None):
1816
"""Return a StringIOWrapper instance, that will encode Unicode
1819
if encoding_type is None:
1820
encoding_type = 'strict'
1822
output_encoding = 'utf-8'
1823
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1824
sio.encoding = output_encoding
1828
class CapturedCall(object):
1829
"""A helper for capturing smart server calls for easy debug analysis."""
1831
def __init__(self, params, prefix_length):
1832
"""Capture the call with params and skip prefix_length stack frames."""
1835
# The last 5 frames are the __init__, the hook frame, and 3 smart
1836
# client frames. Beyond this we could get more clever, but this is good
1838
stack = traceback.extract_stack()[prefix_length:-5]
1839
self.stack = ''.join(traceback.format_list(stack))
1842
return self.call.method
1845
return self.call.method
1851
class TestCaseWithMemoryTransport(TestCase):
1852
"""Common test class for tests that do not need disk resources.
1854
Tests that need disk resources should derive from TestCaseWithTransport.
1856
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1858
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1859
a directory which does not exist. This serves to help ensure test isolation
1860
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1861
must exist. However, TestCaseWithMemoryTransport does not offer local
1862
file defaults for the transport in tests, nor does it obey the command line
1863
override, so tests that accidentally write to the common directory should
1866
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1867
a .bzr directory that stops us ascending higher into the filesystem.
1873
def __init__(self, methodName='runTest'):
1874
# allow test parameterization after test construction and before test
1875
# execution. Variables that the parameterizer sets need to be
1876
# ones that are not set by setUp, or setUp will trash them.
1877
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1878
self.vfs_transport_factory = default_transport
1879
self.transport_server = None
1880
self.transport_readonly_server = None
1881
self.__vfs_server = None
1883
def get_transport(self, relpath=None):
1884
"""Return a writeable transport.
1886
This transport is for the test scratch space relative to
1889
:param relpath: a path relative to the base url.
1891
t = get_transport(self.get_url(relpath))
1892
self.assertFalse(t.is_readonly())
1895
def get_readonly_transport(self, relpath=None):
1896
"""Return a readonly transport for the test scratch space
1898
This can be used to test that operations which should only need
1899
readonly access in fact do not try to write.
1901
:param relpath: a path relative to the base url.
1903
t = get_transport(self.get_readonly_url(relpath))
1904
self.assertTrue(t.is_readonly())
1907
def create_transport_readonly_server(self):
1908
"""Create a transport server from class defined at init.
1910
This is mostly a hook for daughter classes.
1912
return self.transport_readonly_server()
1914
def get_readonly_server(self):
1915
"""Get the server instance for the readonly transport
1917
This is useful for some tests with specific servers to do diagnostics.
1919
if self.__readonly_server is None:
1920
if self.transport_readonly_server is None:
1921
# readonly decorator requested
1922
# bring up the server
1923
self.__readonly_server = ReadonlyServer()
1924
self.__readonly_server.setUp(self.get_vfs_only_server())
1926
self.__readonly_server = self.create_transport_readonly_server()
1927
self.__readonly_server.setUp(self.get_vfs_only_server())
1928
self.addCleanup(self.__readonly_server.tearDown)
1929
return self.__readonly_server
1931
def get_readonly_url(self, relpath=None):
1932
"""Get a URL for the readonly transport.
1934
This will either be backed by '.' or a decorator to the transport
1935
used by self.get_url()
1936
relpath provides for clients to get a path relative to the base url.
1937
These should only be downwards relative, not upwards.
1939
base = self.get_readonly_server().get_url()
1940
return self._adjust_url(base, relpath)
1942
def get_vfs_only_server(self):
1943
"""Get the vfs only read/write server instance.
1945
This is useful for some tests with specific servers that need
1948
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1949
is no means to override it.
1951
if self.__vfs_server is None:
1952
self.__vfs_server = MemoryServer()
1953
self.__vfs_server.setUp()
1954
self.addCleanup(self.__vfs_server.tearDown)
1955
return self.__vfs_server
1957
def get_server(self):
1958
"""Get the read/write server instance.
1960
This is useful for some tests with specific servers that need
1963
This is built from the self.transport_server factory. If that is None,
1964
then the self.get_vfs_server is returned.
1966
if self.__server is None:
1967
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1968
return self.get_vfs_only_server()
1970
# bring up a decorated means of access to the vfs only server.
1971
self.__server = self.transport_server()
1973
self.__server.setUp(self.get_vfs_only_server())
1974
except TypeError, e:
1975
# This should never happen; the try:Except here is to assist
1976
# developers having to update code rather than seeing an
1977
# uninformative TypeError.
1978
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1979
self.addCleanup(self.__server.tearDown)
1980
return self.__server
1982
def _adjust_url(self, base, relpath):
1983
"""Get a URL (or maybe a path) for the readwrite transport.
1985
This will either be backed by '.' or to an equivalent non-file based
1987
relpath provides for clients to get a path relative to the base url.
1988
These should only be downwards relative, not upwards.
1990
if relpath is not None and relpath != '.':
1991
if not base.endswith('/'):
1993
# XXX: Really base should be a url; we did after all call
1994
# get_url()! But sometimes it's just a path (from
1995
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1996
# to a non-escaped local path.
1997
if base.startswith('./') or base.startswith('/'):
2000
base += urlutils.escape(relpath)
2003
def get_url(self, relpath=None):
2004
"""Get a URL (or maybe a path) for the readwrite transport.
2006
This will either be backed by '.' or to an equivalent non-file based
2008
relpath provides for clients to get a path relative to the base url.
2009
These should only be downwards relative, not upwards.
2011
base = self.get_server().get_url()
2012
return self._adjust_url(base, relpath)
2014
def get_vfs_only_url(self, relpath=None):
2015
"""Get a URL (or maybe a path for the plain old vfs transport.
2017
This will never be a smart protocol. It always has all the
2018
capabilities of the local filesystem, but it might actually be a
2019
MemoryTransport or some other similar virtual filesystem.
2021
This is the backing transport (if any) of the server returned by
2022
get_url and get_readonly_url.
2024
:param relpath: provides for clients to get a path relative to the base
2025
url. These should only be downwards relative, not upwards.
2028
base = self.get_vfs_only_server().get_url()
2029
return self._adjust_url(base, relpath)
2031
def _create_safety_net(self):
2032
"""Make a fake bzr directory.
2034
This prevents any tests propagating up onto the TEST_ROOT directory's
2037
root = TestCaseWithMemoryTransport.TEST_ROOT
2038
bzrdir.BzrDir.create_standalone_workingtree(root)
2040
def _check_safety_net(self):
2041
"""Check that the safety .bzr directory have not been touched.
2043
_make_test_root have created a .bzr directory to prevent tests from
2044
propagating. This method ensures than a test did not leaked.
2046
root = TestCaseWithMemoryTransport.TEST_ROOT
2047
wt = workingtree.WorkingTree.open(root)
2048
last_rev = wt.last_revision()
2049
if last_rev != 'null:':
2050
# The current test have modified the /bzr directory, we need to
2051
# recreate a new one or all the followng tests will fail.
2052
# If you need to inspect its content uncomment the following line
2053
# import pdb; pdb.set_trace()
2054
_rmtree_temp_dir(root + '/.bzr')
2055
self._create_safety_net()
2056
raise AssertionError('%s/.bzr should not be modified' % root)
2058
def _make_test_root(self):
2059
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2060
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2061
TestCaseWithMemoryTransport.TEST_ROOT = root
2063
self._create_safety_net()
2065
# The same directory is used by all tests, and we're not
2066
# specifically told when all tests are finished. This will do.
2067
atexit.register(_rmtree_temp_dir, root)
2069
self.addCleanup(self._check_safety_net)
2071
def makeAndChdirToTestDir(self):
2072
"""Create a temporary directories for this one test.
2074
This must set self.test_home_dir and self.test_dir and chdir to
2077
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2079
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2080
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2081
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2083
def make_branch(self, relpath, format=None):
2084
"""Create a branch on the transport at relpath."""
2085
repo = self.make_repository(relpath, format=format)
2086
return repo.bzrdir.create_branch()
2088
def make_bzrdir(self, relpath, format=None):
2090
# might be a relative or absolute path
2091
maybe_a_url = self.get_url(relpath)
2092
segments = maybe_a_url.rsplit('/', 1)
2093
t = get_transport(maybe_a_url)
2094
if len(segments) > 1 and segments[-1] not in ('', '.'):
2098
if isinstance(format, basestring):
2099
format = bzrdir.format_registry.make_bzrdir(format)
2100
return format.initialize_on_transport(t)
2101
except errors.UninitializableFormat:
2102
raise TestSkipped("Format %s is not initializable." % format)
2104
def make_repository(self, relpath, shared=False, format=None):
2105
"""Create a repository on our default transport at relpath.
2107
Note that relpath must be a relative path, not a full url.
2109
# FIXME: If you create a remoterepository this returns the underlying
2110
# real format, which is incorrect. Actually we should make sure that
2111
# RemoteBzrDir returns a RemoteRepository.
2112
# maybe mbp 20070410
2113
made_control = self.make_bzrdir(relpath, format=format)
2114
return made_control.create_repository(shared=shared)
2116
def make_branch_and_memory_tree(self, relpath, format=None):
2117
"""Create a branch on the default transport and a MemoryTree for it."""
2118
b = self.make_branch(relpath, format=format)
2119
return memorytree.MemoryTree.create_on_branch(b)
2121
def make_branch_builder(self, relpath, format=None):
2122
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2125
def overrideEnvironmentForTesting(self):
2126
os.environ['HOME'] = self.test_home_dir
2127
os.environ['BZR_HOME'] = self.test_home_dir
2130
super(TestCaseWithMemoryTransport, self).setUp()
2131
self._make_test_root()
2132
_currentdir = os.getcwdu()
2133
def _leaveDirectory():
2134
os.chdir(_currentdir)
2135
self.addCleanup(_leaveDirectory)
2136
self.makeAndChdirToTestDir()
2137
self.overrideEnvironmentForTesting()
2138
self.__readonly_server = None
2139
self.__server = None
2140
self.reduceLockdirTimeout()
2142
def setup_smart_server_with_call_log(self):
2143
"""Sets up a smart server as the transport server with a call log."""
2144
self.transport_server = server.SmartTCPServer_for_testing
2145
self.hpss_calls = []
2147
# Skip the current stack down to the caller of
2148
# setup_smart_server_with_call_log
2149
prefix_length = len(traceback.extract_stack()) - 2
2150
def capture_hpss_call(params):
2151
self.hpss_calls.append(
2152
CapturedCall(params, prefix_length))
2153
client._SmartClient.hooks.install_named_hook(
2154
'call', capture_hpss_call, None)
2156
def reset_smart_call_log(self):
2157
self.hpss_calls = []
2160
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2161
"""Derived class that runs a test within a temporary directory.
2163
This is useful for tests that need to create a branch, etc.
2165
The directory is created in a slightly complex way: for each
2166
Python invocation, a new temporary top-level directory is created.
2167
All test cases create their own directory within that. If the
2168
tests complete successfully, the directory is removed.
2170
:ivar test_base_dir: The path of the top-level directory for this
2171
test, which contains a home directory and a work directory.
2173
:ivar test_home_dir: An initially empty directory under test_base_dir
2174
which is used as $HOME for this test.
2176
:ivar test_dir: A directory under test_base_dir used as the current
2177
directory when the test proper is run.
2180
OVERRIDE_PYTHON = 'python'
2182
def check_file_contents(self, filename, expect):
2183
self.log("check contents of file %s" % filename)
2184
contents = file(filename, 'r').read()
2185
if contents != expect:
2186
self.log("expected: %r" % expect)
2187
self.log("actually: %r" % contents)
2188
self.fail("contents of %s not as expected" % filename)
2190
def _getTestDirPrefix(self):
2191
# create a directory within the top level test directory
2192
if sys.platform == 'win32':
2193
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2194
# windows is likely to have path-length limits so use a short name
2195
name_prefix = name_prefix[-30:]
2197
name_prefix = re.sub('[/]', '_', self.id())
2200
def makeAndChdirToTestDir(self):
2201
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2203
For TestCaseInTempDir we create a temporary directory based on the test
2204
name and then create two subdirs - test and home under it.
2206
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2208
for i in range(100):
2209
if os.path.exists(name):
2210
name = name_prefix + '_' + str(i)
2214
# now create test and home directories within this dir
2215
self.test_base_dir = name
2216
self.test_home_dir = self.test_base_dir + '/home'
2217
os.mkdir(self.test_home_dir)
2218
self.test_dir = self.test_base_dir + '/work'
2219
os.mkdir(self.test_dir)
2220
os.chdir(self.test_dir)
2221
# put name of test inside
2222
f = file(self.test_base_dir + '/name', 'w')
2227
self.addCleanup(self.deleteTestDir)
2229
def deleteTestDir(self):
2230
os.chdir(self.TEST_ROOT)
2231
_rmtree_temp_dir(self.test_base_dir)
2233
def build_tree(self, shape, line_endings='binary', transport=None):
2234
"""Build a test tree according to a pattern.
2236
shape is a sequence of file specifications. If the final
2237
character is '/', a directory is created.
2239
This assumes that all the elements in the tree being built are new.
2241
This doesn't add anything to a branch.
2243
:type shape: list or tuple.
2244
:param line_endings: Either 'binary' or 'native'
2245
in binary mode, exact contents are written in native mode, the
2246
line endings match the default platform endings.
2247
:param transport: A transport to write to, for building trees on VFS's.
2248
If the transport is readonly or None, "." is opened automatically.
2251
if type(shape) not in (list, tuple):
2252
raise AssertionError("Parameter 'shape' should be "
2253
"a list or a tuple. Got %r instead" % (shape,))
2254
# It's OK to just create them using forward slashes on windows.
2255
if transport is None or transport.is_readonly():
2256
transport = get_transport(".")
2258
self.assertIsInstance(name, basestring)
2260
transport.mkdir(urlutils.escape(name[:-1]))
2262
if line_endings == 'binary':
2264
elif line_endings == 'native':
2267
raise errors.BzrError(
2268
'Invalid line ending request %r' % line_endings)
2269
content = "contents of %s%s" % (name.encode('utf-8'), end)
2270
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2272
def build_tree_contents(self, shape):
2273
build_tree_contents(shape)
2275
def assertInWorkingTree(self, path, root_path='.', tree=None):
2276
"""Assert whether path or paths are in the WorkingTree"""
2278
tree = workingtree.WorkingTree.open(root_path)
2279
if not isinstance(path, basestring):
2281
self.assertInWorkingTree(p, tree=tree)
2283
self.assertIsNot(tree.path2id(path), None,
2284
path+' not in working tree.')
2286
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2287
"""Assert whether path or paths are not in the WorkingTree"""
2289
tree = workingtree.WorkingTree.open(root_path)
2290
if not isinstance(path, basestring):
2292
self.assertNotInWorkingTree(p,tree=tree)
2294
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2297
class TestCaseWithTransport(TestCaseInTempDir):
2298
"""A test case that provides get_url and get_readonly_url facilities.
2300
These back onto two transport servers, one for readonly access and one for
2303
If no explicit class is provided for readonly access, a
2304
ReadonlyTransportDecorator is used instead which allows the use of non disk
2305
based read write transports.
2307
If an explicit class is provided for readonly access, that server and the
2308
readwrite one must both define get_url() as resolving to os.getcwd().
2311
def get_vfs_only_server(self):
2312
"""See TestCaseWithMemoryTransport.
2314
This is useful for some tests with specific servers that need
2317
if self.__vfs_server is None:
2318
self.__vfs_server = self.vfs_transport_factory()
2319
self.__vfs_server.setUp()
2320
self.addCleanup(self.__vfs_server.tearDown)
2321
return self.__vfs_server
2323
def make_branch_and_tree(self, relpath, format=None):
2324
"""Create a branch on the transport and a tree locally.
2326
If the transport is not a LocalTransport, the Tree can't be created on
2327
the transport. In that case if the vfs_transport_factory is
2328
LocalURLServer the working tree is created in the local
2329
directory backing the transport, and the returned tree's branch and
2330
repository will also be accessed locally. Otherwise a lightweight
2331
checkout is created and returned.
2333
:param format: The BzrDirFormat.
2334
:returns: the WorkingTree.
2336
# TODO: always use the local disk path for the working tree,
2337
# this obviously requires a format that supports branch references
2338
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2340
b = self.make_branch(relpath, format=format)
2342
return b.bzrdir.create_workingtree()
2343
except errors.NotLocalUrl:
2344
# We can only make working trees locally at the moment. If the
2345
# transport can't support them, then we keep the non-disk-backed
2346
# branch and create a local checkout.
2347
if self.vfs_transport_factory is LocalURLServer:
2348
# the branch is colocated on disk, we cannot create a checkout.
2349
# hopefully callers will expect this.
2350
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2351
wt = local_controldir.create_workingtree()
2352
if wt.branch._format != b._format:
2354
# Make sure that assigning to wt._branch fixes wt.branch,
2355
# in case the implementation details of workingtree objects
2357
self.assertIs(b, wt.branch)
2360
return b.create_checkout(relpath, lightweight=True)
2362
def assertIsDirectory(self, relpath, transport):
2363
"""Assert that relpath within transport is a directory.
2365
This may not be possible on all transports; in that case it propagates
2366
a TransportNotPossible.
2369
mode = transport.stat(relpath).st_mode
2370
except errors.NoSuchFile:
2371
self.fail("path %s is not a directory; no such file"
2373
if not stat.S_ISDIR(mode):
2374
self.fail("path %s is not a directory; has mode %#o"
2377
def assertTreesEqual(self, left, right):
2378
"""Check that left and right have the same content and properties."""
2379
# we use a tree delta to check for equality of the content, and we
2380
# manually check for equality of other things such as the parents list.
2381
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2382
differences = left.changes_from(right)
2383
self.assertFalse(differences.has_changed(),
2384
"Trees %r and %r are different: %r" % (left, right, differences))
2387
super(TestCaseWithTransport, self).setUp()
2388
self.__vfs_server = None
2391
class ChrootedTestCase(TestCaseWithTransport):
2392
"""A support class that provides readonly urls outside the local namespace.
2394
This is done by checking if self.transport_server is a MemoryServer. if it
2395
is then we are chrooted already, if it is not then an HttpServer is used
2398
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2399
be used without needed to redo it when a different
2400
subclass is in use ?
2404
super(ChrootedTestCase, self).setUp()
2405
if not self.vfs_transport_factory == MemoryServer:
2406
self.transport_readonly_server = HttpServer
2409
def condition_id_re(pattern):
2410
"""Create a condition filter which performs a re check on a test's id.
2412
:param pattern: A regular expression string.
2413
:return: A callable that returns True if the re matches.
2415
filter_re = re.compile(pattern)
2416
def condition(test):
2418
return filter_re.search(test_id)
2422
def condition_isinstance(klass_or_klass_list):
2423
"""Create a condition filter which returns isinstance(param, klass).
2425
:return: A callable which when called with one parameter obj return the
2426
result of isinstance(obj, klass_or_klass_list).
2429
return isinstance(obj, klass_or_klass_list)
2433
def condition_id_in_list(id_list):
2434
"""Create a condition filter which verify that test's id in a list.
2436
:param id_list: A TestIdList object.
2437
:return: A callable that returns True if the test's id appears in the list.
2439
def condition(test):
2440
return id_list.includes(test.id())
2444
def condition_id_startswith(starts):
2445
"""Create a condition filter verifying that test's id starts with a string.
2447
:param starts: A list of string.
2448
:return: A callable that returns True if the test's id starts with one of
2451
def condition(test):
2452
for start in starts:
2453
if test.id().startswith(start):
2459
def exclude_tests_by_condition(suite, condition):
2460
"""Create a test suite which excludes some tests from suite.
2462
:param suite: The suite to get tests from.
2463
:param condition: A callable whose result evaluates True when called with a
2464
test case which should be excluded from the result.
2465
:return: A suite which contains the tests found in suite that fail
2469
for test in iter_suite_tests(suite):
2470
if not condition(test):
2472
return TestUtil.TestSuite(result)
2475
def filter_suite_by_condition(suite, condition):
2476
"""Create a test suite by filtering another one.
2478
:param suite: The source suite.
2479
:param condition: A callable whose result evaluates True when called with a
2480
test case which should be included in the result.
2481
:return: A suite which contains the tests found in suite that pass
2485
for test in iter_suite_tests(suite):
2488
return TestUtil.TestSuite(result)
2491
def filter_suite_by_re(suite, pattern):
2492
"""Create a test suite by filtering another one.
2494
:param suite: the source suite
2495
:param pattern: pattern that names must match
2496
:returns: the newly created suite
2498
condition = condition_id_re(pattern)
2499
result_suite = filter_suite_by_condition(suite, condition)
2503
def filter_suite_by_id_list(suite, test_id_list):
2504
"""Create a test suite by filtering another one.
2506
:param suite: The source suite.
2507
:param test_id_list: A list of the test ids to keep as strings.
2508
:returns: the newly created suite
2510
condition = condition_id_in_list(test_id_list)
2511
result_suite = filter_suite_by_condition(suite, condition)
2515
def filter_suite_by_id_startswith(suite, start):
2516
"""Create a test suite by filtering another one.
2518
:param suite: The source suite.
2519
:param start: A list of string the test id must start with one of.
2520
:returns: the newly created suite
2522
condition = condition_id_startswith(start)
2523
result_suite = filter_suite_by_condition(suite, condition)
2527
def exclude_tests_by_re(suite, pattern):
2528
"""Create a test suite which excludes some tests from suite.
2530
:param suite: The suite to get tests from.
2531
:param pattern: A regular expression string. Test ids that match this
2532
pattern will be excluded from the result.
2533
:return: A TestSuite that contains all the tests from suite without the
2534
tests that matched pattern. The order of tests is the same as it was in
2537
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2540
def preserve_input(something):
2541
"""A helper for performing test suite transformation chains.
2543
:param something: Anything you want to preserve.
2549
def randomize_suite(suite):
2550
"""Return a new TestSuite with suite's tests in random order.
2552
The tests in the input suite are flattened into a single suite in order to
2553
accomplish this. Any nested TestSuites are removed to provide global
2556
tests = list(iter_suite_tests(suite))
2557
random.shuffle(tests)
2558
return TestUtil.TestSuite(tests)
2561
def split_suite_by_condition(suite, condition):
2562
"""Split a test suite into two by a condition.
2564
:param suite: The suite to split.
2565
:param condition: The condition to match on. Tests that match this
2566
condition are returned in the first test suite, ones that do not match
2567
are in the second suite.
2568
:return: A tuple of two test suites, where the first contains tests from
2569
suite matching the condition, and the second contains the remainder
2570
from suite. The order within each output suite is the same as it was in
2575
for test in iter_suite_tests(suite):
2577
matched.append(test)
2579
did_not_match.append(test)
2580
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2583
def split_suite_by_re(suite, pattern):
2584
"""Split a test suite into two by a regular expression.
2586
:param suite: The suite to split.
2587
:param pattern: A regular expression string. Test ids that match this
2588
pattern will be in the first test suite returned, and the others in the
2589
second test suite returned.
2590
:return: A tuple of two test suites, where the first contains tests from
2591
suite matching pattern, and the second contains the remainder from
2592
suite. The order within each output suite is the same as it was in
2595
return split_suite_by_condition(suite, condition_id_re(pattern))
2598
def run_suite(suite, name='test', verbose=False, pattern=".*",
2599
stop_on_failure=False,
2600
transport=None, lsprof_timed=None, bench_history=None,
2601
matching_tests_first=None,
2604
exclude_pattern=None,
2607
"""Run a test suite for bzr selftest.
2609
:param runner_class: The class of runner to use. Must support the
2610
constructor arguments passed by run_suite which are more than standard
2612
:return: A boolean indicating success.
2614
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2619
if runner_class is None:
2620
runner_class = TextTestRunner
2621
runner = runner_class(stream=sys.stdout,
2623
verbosity=verbosity,
2624
bench_history=bench_history,
2625
list_only=list_only,
2627
runner.stop_on_failure=stop_on_failure
2628
# Initialise the random number generator and display the seed used.
2629
# We convert the seed to a long to make it reuseable across invocations.
2630
random_order = False
2631
if random_seed is not None:
2633
if random_seed == "now":
2634
random_seed = long(time.time())
2636
# Convert the seed to a long if we can
2638
random_seed = long(random_seed)
2641
runner.stream.writeln("Randomizing test order using seed %s\n" %
2643
random.seed(random_seed)
2644
# Customise the list of tests if requested
2645
if exclude_pattern is not None:
2646
suite = exclude_tests_by_re(suite, exclude_pattern)
2648
order_changer = randomize_suite
2650
order_changer = preserve_input
2651
if pattern != '.*' or random_order:
2652
if matching_tests_first:
2653
suites = map(order_changer, split_suite_by_re(suite, pattern))
2654
suite = TestUtil.TestSuite(suites)
2656
suite = order_changer(filter_suite_by_re(suite, pattern))
2658
result = runner.run(suite)
2661
return result.wasStrictlySuccessful()
2663
return result.wasSuccessful()
2666
# Controlled by "bzr selftest -E=..." option
2667
selftest_debug_flags = set()
2670
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2672
test_suite_factory=None,
2675
matching_tests_first=None,
2678
exclude_pattern=None,
2685
"""Run the whole test suite under the enhanced runner"""
2686
# XXX: Very ugly way to do this...
2687
# Disable warning about old formats because we don't want it to disturb
2688
# any blackbox tests.
2689
from bzrlib import repository
2690
repository._deprecation_warning_done = True
2692
global default_transport
2693
if transport is None:
2694
transport = default_transport
2695
old_transport = default_transport
2696
default_transport = transport
2697
global selftest_debug_flags
2698
old_debug_flags = selftest_debug_flags
2699
if debug_flags is not None:
2700
selftest_debug_flags = set(debug_flags)
2702
if load_list is None:
2705
keep_only = load_test_id_list(load_list)
2706
if test_suite_factory is None:
2707
suite = test_suite(keep_only, starting_with)
2709
suite = test_suite_factory()
2710
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2711
stop_on_failure=stop_on_failure,
2712
transport=transport,
2713
lsprof_timed=lsprof_timed,
2714
bench_history=bench_history,
2715
matching_tests_first=matching_tests_first,
2716
list_only=list_only,
2717
random_seed=random_seed,
2718
exclude_pattern=exclude_pattern,
2720
runner_class=runner_class,
2723
default_transport = old_transport
2724
selftest_debug_flags = old_debug_flags
2727
def load_test_id_list(file_name):
2728
"""Load a test id list from a text file.
2730
The format is one test id by line. No special care is taken to impose
2731
strict rules, these test ids are used to filter the test suite so a test id
2732
that do not match an existing test will do no harm. This allows user to add
2733
comments, leave blank lines, etc.
2737
ftest = open(file_name, 'rt')
2739
if e.errno != errno.ENOENT:
2742
raise errors.NoSuchFile(file_name)
2744
for test_name in ftest.readlines():
2745
test_list.append(test_name.strip())
2750
def suite_matches_id_list(test_suite, id_list):
2751
"""Warns about tests not appearing or appearing more than once.
2753
:param test_suite: A TestSuite object.
2754
:param test_id_list: The list of test ids that should be found in
2757
:return: (absents, duplicates) absents is a list containing the test found
2758
in id_list but not in test_suite, duplicates is a list containing the
2759
test found multiple times in test_suite.
2761
When using a prefined test id list, it may occurs that some tests do not
2762
exist anymore or that some tests use the same id. This function warns the
2763
tester about potential problems in his workflow (test lists are volatile)
2764
or in the test suite itself (using the same id for several tests does not
2765
help to localize defects).
2767
# Build a dict counting id occurrences
2769
for test in iter_suite_tests(test_suite):
2771
tests[id] = tests.get(id, 0) + 1
2776
occurs = tests.get(id, 0)
2778
not_found.append(id)
2780
duplicates.append(id)
2782
return not_found, duplicates
2785
class TestIdList(object):
2786
"""Test id list to filter a test suite.
2788
Relying on the assumption that test ids are built as:
2789
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2790
notation, this class offers methods to :
2791
- avoid building a test suite for modules not refered to in the test list,
2792
- keep only the tests listed from the module test suite.
2795
def __init__(self, test_id_list):
2796
# When a test suite needs to be filtered against us we compare test ids
2797
# for equality, so a simple dict offers a quick and simple solution.
2798
self.tests = dict().fromkeys(test_id_list, True)
2800
# While unittest.TestCase have ids like:
2801
# <module>.<class>.<method>[(<param+)],
2802
# doctest.DocTestCase can have ids like:
2805
# <module>.<function>
2806
# <module>.<class>.<method>
2808
# Since we can't predict a test class from its name only, we settle on
2809
# a simple constraint: a test id always begins with its module name.
2812
for test_id in test_id_list:
2813
parts = test_id.split('.')
2814
mod_name = parts.pop(0)
2815
modules[mod_name] = True
2817
mod_name += '.' + part
2818
modules[mod_name] = True
2819
self.modules = modules
2821
def refers_to(self, module_name):
2822
"""Is there tests for the module or one of its sub modules."""
2823
return self.modules.has_key(module_name)
2825
def includes(self, test_id):
2826
return self.tests.has_key(test_id)
2829
class TestPrefixAliasRegistry(registry.Registry):
2830
"""A registry for test prefix aliases.
2832
This helps implement shorcuts for the --starting-with selftest
2833
option. Overriding existing prefixes is not allowed but not fatal (a
2834
warning will be emitted).
2837
def register(self, key, obj, help=None, info=None,
2838
override_existing=False):
2839
"""See Registry.register.
2841
Trying to override an existing alias causes a warning to be emitted,
2842
not a fatal execption.
2845
super(TestPrefixAliasRegistry, self).register(
2846
key, obj, help=help, info=info, override_existing=False)
2848
actual = self.get(key)
2849
note('Test prefix alias %s is already used for %s, ignoring %s'
2850
% (key, actual, obj))
2852
def resolve_alias(self, id_start):
2853
"""Replace the alias by the prefix in the given string.
2855
Using an unknown prefix is an error to help catching typos.
2857
parts = id_start.split('.')
2859
parts[0] = self.get(parts[0])
2861
raise errors.BzrCommandError(
2862
'%s is not a known test prefix alias' % parts[0])
2863
return '.'.join(parts)
2866
test_prefix_alias_registry = TestPrefixAliasRegistry()
2867
"""Registry of test prefix aliases."""
2870
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2871
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2872
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2874
# Obvious higest levels prefixes, feel free to add your own via a plugin
2875
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2876
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2877
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2878
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2879
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2882
def test_suite(keep_only=None, starting_with=None):
2883
"""Build and return TestSuite for the whole of bzrlib.
2885
:param keep_only: A list of test ids limiting the suite returned.
2887
:param starting_with: An id limiting the suite returned to the tests
2890
This function can be replaced if you need to change the default test
2891
suite on a global basis, but it is not encouraged.
2895
'bzrlib.tests.blackbox',
2896
'bzrlib.tests.branch_implementations',
2897
'bzrlib.tests.bzrdir_implementations',
2898
'bzrlib.tests.commands',
2899
'bzrlib.tests.interrepository_implementations',
2900
'bzrlib.tests.intertree_implementations',
2901
'bzrlib.tests.inventory_implementations',
2902
'bzrlib.tests.per_interbranch',
2903
'bzrlib.tests.per_lock',
2904
'bzrlib.tests.per_repository',
2905
'bzrlib.tests.per_repository_reference',
2906
'bzrlib.tests.test__dirstate_helpers',
2907
'bzrlib.tests.test__walkdirs_win32',
2908
'bzrlib.tests.test_ancestry',
2909
'bzrlib.tests.test_annotate',
2910
'bzrlib.tests.test_api',
2911
'bzrlib.tests.test_atomicfile',
2912
'bzrlib.tests.test_bad_files',
2913
'bzrlib.tests.test_bisect_multi',
2914
'bzrlib.tests.test_branch',
2915
'bzrlib.tests.test_branchbuilder',
2916
'bzrlib.tests.test_btree_index',
2917
'bzrlib.tests.test_bugtracker',
2918
'bzrlib.tests.test_bundle',
2919
'bzrlib.tests.test_bzrdir',
2920
'bzrlib.tests.test_cache_utf8',
2921
'bzrlib.tests.test_clean_tree',
2922
'bzrlib.tests.test_chunk_writer',
2923
'bzrlib.tests.test__chunks_to_lines',
2924
'bzrlib.tests.test_commands',
2925
'bzrlib.tests.test_commit',
2926
'bzrlib.tests.test_commit_merge',
2927
'bzrlib.tests.test_config',
2928
'bzrlib.tests.test_conflicts',
2929
'bzrlib.tests.test_counted_lock',
2930
'bzrlib.tests.test_decorators',
2931
'bzrlib.tests.test_delta',
2932
'bzrlib.tests.test_debug',
2933
'bzrlib.tests.test_deprecated_graph',
2934
'bzrlib.tests.test_diff',
2935
'bzrlib.tests.test_directory_service',
2936
'bzrlib.tests.test_dirstate',
2937
'bzrlib.tests.test_email_message',
2938
'bzrlib.tests.test_errors',
2939
'bzrlib.tests.test_export',
2940
'bzrlib.tests.test_extract',
2941
'bzrlib.tests.test_fetch',
2942
'bzrlib.tests.test_fifo_cache',
2943
'bzrlib.tests.test_ftp_transport',
2944
'bzrlib.tests.test_foreign',
2945
'bzrlib.tests.test_generate_docs',
2946
'bzrlib.tests.test_generate_ids',
2947
'bzrlib.tests.test_globbing',
2948
'bzrlib.tests.test_gpg',
2949
'bzrlib.tests.test_graph',
2950
'bzrlib.tests.test_hashcache',
2951
'bzrlib.tests.test_help',
2952
'bzrlib.tests.test_hooks',
2953
'bzrlib.tests.test_http',
2954
'bzrlib.tests.test_http_implementations',
2955
'bzrlib.tests.test_http_response',
2956
'bzrlib.tests.test_https_ca_bundle',
2957
'bzrlib.tests.test_identitymap',
2958
'bzrlib.tests.test_ignores',
2959
'bzrlib.tests.test_index',
2960
'bzrlib.tests.test_info',
2961
'bzrlib.tests.test_inv',
2962
'bzrlib.tests.test_knit',
2963
'bzrlib.tests.test_lazy_import',
2964
'bzrlib.tests.test_lazy_regex',
2965
'bzrlib.tests.test_lockable_files',
2966
'bzrlib.tests.test_lockdir',
2967
'bzrlib.tests.test_log',
2968
'bzrlib.tests.test_lru_cache',
2969
'bzrlib.tests.test_lsprof',
2970
'bzrlib.tests.test_mail_client',
2971
'bzrlib.tests.test_memorytree',
2972
'bzrlib.tests.test_merge',
2973
'bzrlib.tests.test_merge3',
2974
'bzrlib.tests.test_merge_core',
2975
'bzrlib.tests.test_merge_directive',
2976
'bzrlib.tests.test_missing',
2977
'bzrlib.tests.test_msgeditor',
2978
'bzrlib.tests.test_multiparent',
2979
'bzrlib.tests.test_mutabletree',
2980
'bzrlib.tests.test_nonascii',
2981
'bzrlib.tests.test_options',
2982
'bzrlib.tests.test_osutils',
2983
'bzrlib.tests.test_osutils_encodings',
2984
'bzrlib.tests.test_pack',
2985
'bzrlib.tests.test_pack_repository',
2986
'bzrlib.tests.test_patch',
2987
'bzrlib.tests.test_patches',
2988
'bzrlib.tests.test_permissions',
2989
'bzrlib.tests.test_plugins',
2990
'bzrlib.tests.test_progress',
2991
'bzrlib.tests.test_read_bundle',
2992
'bzrlib.tests.test_reconcile',
2993
'bzrlib.tests.test_reconfigure',
2994
'bzrlib.tests.test_registry',
2995
'bzrlib.tests.test_remote',
2996
'bzrlib.tests.test_repository',
2997
'bzrlib.tests.test_revert',
2998
'bzrlib.tests.test_revision',
2999
'bzrlib.tests.test_revisionspec',
3000
'bzrlib.tests.test_revisiontree',
3001
'bzrlib.tests.test_rio',
3002
'bzrlib.tests.test_rules',
3003
'bzrlib.tests.test_sampler',
3004
'bzrlib.tests.test_selftest',
3005
'bzrlib.tests.test_setup',
3006
'bzrlib.tests.test_sftp_transport',
3007
'bzrlib.tests.test_shelf',
3008
'bzrlib.tests.test_shelf_ui',
3009
'bzrlib.tests.test_smart',
3010
'bzrlib.tests.test_smart_add',
3011
'bzrlib.tests.test_smart_request',
3012
'bzrlib.tests.test_smart_transport',
3013
'bzrlib.tests.test_smtp_connection',
3014
'bzrlib.tests.test_source',
3015
'bzrlib.tests.test_ssh_transport',
3016
'bzrlib.tests.test_status',
3017
'bzrlib.tests.test_store',
3018
'bzrlib.tests.test_strace',
3019
'bzrlib.tests.test_subsume',
3020
'bzrlib.tests.test_switch',
3021
'bzrlib.tests.test_symbol_versioning',
3022
'bzrlib.tests.test_tag',
3023
'bzrlib.tests.test_testament',
3024
'bzrlib.tests.test_textfile',
3025
'bzrlib.tests.test_textmerge',
3026
'bzrlib.tests.test_timestamp',
3027
'bzrlib.tests.test_trace',
3028
'bzrlib.tests.test_transactions',
3029
'bzrlib.tests.test_transform',
3030
'bzrlib.tests.test_transport',
3031
'bzrlib.tests.test_transport_implementations',
3032
'bzrlib.tests.test_transport_log',
3033
'bzrlib.tests.test_tree',
3034
'bzrlib.tests.test_treebuilder',
3035
'bzrlib.tests.test_tsort',
3036
'bzrlib.tests.test_tuned_gzip',
3037
'bzrlib.tests.test_ui',
3038
'bzrlib.tests.test_uncommit',
3039
'bzrlib.tests.test_upgrade',
3040
'bzrlib.tests.test_upgrade_stacked',
3041
'bzrlib.tests.test_urlutils',
3042
'bzrlib.tests.test_version',
3043
'bzrlib.tests.test_version_info',
3044
'bzrlib.tests.test_versionedfile',
3045
'bzrlib.tests.test_weave',
3046
'bzrlib.tests.test_whitebox',
3047
'bzrlib.tests.test_win32utils',
3048
'bzrlib.tests.test_workingtree',
3049
'bzrlib.tests.test_workingtree_4',
3050
'bzrlib.tests.test_wsgi',
3051
'bzrlib.tests.test_xml',
3052
'bzrlib.tests.tree_implementations',
3053
'bzrlib.tests.workingtree_implementations',
3054
'bzrlib.util.tests.test_bencode',
3057
loader = TestUtil.TestLoader()
3060
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3061
for start in starting_with]
3062
# We take precedence over keep_only because *at loading time* using
3063
# both options means we will load less tests for the same final result.
3064
def interesting_module(name):
3065
for start in starting_with:
3067
# Either the module name starts with the specified string
3068
name.startswith(start)
3069
# or it may contain tests starting with the specified string
3070
or start.startswith(name)
3074
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3076
elif keep_only is not None:
3077
id_filter = TestIdList(keep_only)
3078
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3079
def interesting_module(name):
3080
return id_filter.refers_to(name)
3083
loader = TestUtil.TestLoader()
3084
def interesting_module(name):
3085
# No filtering, all modules are interesting
3088
suite = loader.suiteClass()
3090
# modules building their suite with loadTestsFromModuleNames
3091
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3093
modules_to_doctest = [
3095
'bzrlib.branchbuilder',
3098
'bzrlib.iterablefile',
3102
'bzrlib.symbol_versioning',
3105
'bzrlib.version_info_formats.format_custom',
3108
for mod in modules_to_doctest:
3109
if not interesting_module(mod):
3110
# No tests to keep here, move along
3113
# note that this really does mean "report only" -- doctest
3114
# still runs the rest of the examples
3115
doc_suite = doctest.DocTestSuite(mod,
3116
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3117
except ValueError, e:
3118
print '**failed to get doctest for: %s\n%s' % (mod, e)
3120
if len(doc_suite._tests) == 0:
3121
raise errors.BzrError("no doctests found in %s" % (mod,))
3122
suite.addTest(doc_suite)
3124
default_encoding = sys.getdefaultencoding()
3125
for name, plugin in bzrlib.plugin.plugins().items():
3126
if not interesting_module(plugin.module.__name__):
3128
plugin_suite = plugin.test_suite()
3129
# We used to catch ImportError here and turn it into just a warning,
3130
# but really if you don't have --no-plugins this should be a failure.
3131
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3132
if plugin_suite is None:
3133
plugin_suite = plugin.load_plugin_tests(loader)
3134
if plugin_suite is not None:
3135
suite.addTest(plugin_suite)
3136
if default_encoding != sys.getdefaultencoding():
3137
bzrlib.trace.warning(
3138
'Plugin "%s" tried to reset default encoding to: %s', name,
3139
sys.getdefaultencoding())
3141
sys.setdefaultencoding(default_encoding)
3144
suite = filter_suite_by_id_startswith(suite, starting_with)
3146
if keep_only is not None:
3147
# Now that the referred modules have loaded their tests, keep only the
3149
suite = filter_suite_by_id_list(suite, id_filter)
3150
# Do some sanity checks on the id_list filtering
3151
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3153
# The tester has used both keep_only and starting_with, so he is
3154
# already aware that some tests are excluded from the list, there
3155
# is no need to tell him which.
3158
# Some tests mentioned in the list are not in the test suite. The
3159
# list may be out of date, report to the tester.
3160
for id in not_found:
3161
bzrlib.trace.warning('"%s" not found in the test suite', id)
3162
for id in duplicates:
3163
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3168
def multiply_scenarios(scenarios_left, scenarios_right):
3169
"""Multiply two sets of scenarios.
3171
:returns: the cartesian product of the two sets of scenarios, that is
3172
a scenario for every possible combination of a left scenario and a
3176
('%s,%s' % (left_name, right_name),
3177
dict(left_dict.items() + right_dict.items()))
3178
for left_name, left_dict in scenarios_left
3179
for right_name, right_dict in scenarios_right]
3182
def multiply_tests(tests, scenarios, result):
3183
"""Multiply tests_list by scenarios into result.
3185
This is the core workhorse for test parameterisation.
3187
Typically the load_tests() method for a per-implementation test suite will
3188
call multiply_tests and return the result.
3190
:param tests: The tests to parameterise.
3191
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3192
scenario_param_dict).
3193
:param result: A TestSuite to add created tests to.
3195
This returns the passed in result TestSuite with the cross product of all
3196
the tests repeated once for each scenario. Each test is adapted by adding
3197
the scenario name at the end of its id(), and updating the test object's
3198
__dict__ with the scenario_param_dict.
3200
>>> r = multiply_tests(
3201
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3202
... [('one', dict(param=1)),
3203
... ('two', dict(param=2))],
3205
>>> tests = list(iter_suite_tests(r))
3209
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3215
for test in iter_suite_tests(tests):
3216
apply_scenarios(test, scenarios, result)
3220
def apply_scenarios(test, scenarios, result):
3221
"""Apply the scenarios in scenarios to test and add to result.
3223
:param test: The test to apply scenarios to.
3224
:param scenarios: An iterable of scenarios to apply to test.
3226
:seealso: apply_scenario
3228
for scenario in scenarios:
3229
result.addTest(apply_scenario(test, scenario))
3233
def apply_scenario(test, scenario):
3234
"""Copy test and apply scenario to it.
3236
:param test: A test to adapt.
3237
:param scenario: A tuple describing the scenarion.
3238
The first element of the tuple is the new test id.
3239
The second element is a dict containing attributes to set on the
3241
:return: The adapted test.
3243
new_id = "%s(%s)" % (test.id(), scenario[0])
3244
new_test = clone_test(test, new_id)
3245
for name, value in scenario[1].items():
3246
setattr(new_test, name, value)
3250
def clone_test(test, new_id):
3251
"""Clone a test giving it a new id.
3253
:param test: The test to clone.
3254
:param new_id: The id to assign to it.
3255
:return: The new test.
3257
from copy import deepcopy
3258
new_test = deepcopy(test)
3259
new_test.id = lambda: new_id
3263
def _rmtree_temp_dir(dirname):
3264
# If LANG=C we probably have created some bogus paths
3265
# which rmtree(unicode) will fail to delete
3266
# so make sure we are using rmtree(str) to delete everything
3267
# except on win32, where rmtree(str) will fail
3268
# since it doesn't have the property of byte-stream paths
3269
# (they are either ascii or mbcs)
3270
if sys.platform == 'win32':
3271
# make sure we are using the unicode win32 api
3272
dirname = unicode(dirname)
3274
dirname = dirname.encode(sys.getfilesystemencoding())
3276
osutils.rmtree(dirname)
3278
if sys.platform == 'win32' and e.errno == errno.EACCES:
3279
sys.stderr.write(('Permission denied: '
3280
'unable to remove testing dir '
3281
'%s\n' % os.path.basename(dirname)))
3286
class Feature(object):
3287
"""An operating system Feature."""
3290
self._available = None
3292
def available(self):
3293
"""Is the feature available?
3295
:return: True if the feature is available.
3297
if self._available is None:
3298
self._available = self._probe()
3299
return self._available
3302
"""Implement this method in concrete features.
3304
:return: True if the feature is available.
3306
raise NotImplementedError
3309
if getattr(self, 'feature_name', None):
3310
return self.feature_name()
3311
return self.__class__.__name__
3314
class _SymlinkFeature(Feature):
3317
return osutils.has_symlinks()
3319
def feature_name(self):
3322
SymlinkFeature = _SymlinkFeature()
3325
class _HardlinkFeature(Feature):
3328
return osutils.has_hardlinks()
3330
def feature_name(self):
3333
HardlinkFeature = _HardlinkFeature()
3336
class _OsFifoFeature(Feature):
3339
return getattr(os, 'mkfifo', None)
3341
def feature_name(self):
3342
return 'filesystem fifos'
3344
OsFifoFeature = _OsFifoFeature()
3347
class _UnicodeFilenameFeature(Feature):
3348
"""Does the filesystem support Unicode filenames?"""
3352
# Check for character combinations unlikely to be covered by any
3353
# single non-unicode encoding. We use the characters
3354
# - greek small letter alpha (U+03B1) and
3355
# - braille pattern dots-123456 (U+283F).
3356
os.stat(u'\u03b1\u283f')
3357
except UnicodeEncodeError:
3359
except (IOError, OSError):
3360
# The filesystem allows the Unicode filename but the file doesn't
3364
# The filesystem allows the Unicode filename and the file exists,
3368
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3371
def probe_unicode_in_user_encoding():
3372
"""Try to encode several unicode strings to use in unicode-aware tests.
3373
Return first successfull match.
3375
:return: (unicode value, encoded plain string value) or (None, None)
3377
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3378
for uni_val in possible_vals:
3380
str_val = uni_val.encode(osutils.get_user_encoding())
3381
except UnicodeEncodeError:
3382
# Try a different character
3385
return uni_val, str_val
3389
def probe_bad_non_ascii(encoding):
3390
"""Try to find [bad] character with code [128..255]
3391
that cannot be decoded to unicode in some encoding.
3392
Return None if all non-ascii characters is valid
3395
for i in xrange(128, 256):
3398
char.decode(encoding)
3399
except UnicodeDecodeError:
3404
class _FTPServerFeature(Feature):
3405
"""Some tests want an FTP Server, check if one is available.
3407
Right now, the only way this is available is if 'medusa' is installed.
3408
http://www.amk.ca/python/code/medusa.html
3413
import bzrlib.tests.ftp_server
3418
def feature_name(self):
3422
FTPServerFeature = _FTPServerFeature()
3425
class _HTTPSServerFeature(Feature):
3426
"""Some tests want an https Server, check if one is available.
3428
Right now, the only way this is available is under python2.6 which provides
3439
def feature_name(self):
3440
return 'HTTPSServer'
3443
HTTPSServerFeature = _HTTPSServerFeature()
3446
class _UnicodeFilename(Feature):
3447
"""Does the filesystem support Unicode filenames?"""
3452
except UnicodeEncodeError:
3454
except (IOError, OSError):
3455
# The filesystem allows the Unicode filename but the file doesn't
3459
# The filesystem allows the Unicode filename and the file exists,
3463
UnicodeFilename = _UnicodeFilename()
3466
class _UTF8Filesystem(Feature):
3467
"""Is the filesystem UTF-8?"""
3470
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3474
UTF8Filesystem = _UTF8Filesystem()
3477
class _CaseInsCasePresFilenameFeature(Feature):
3478
"""Is the file-system case insensitive, but case-preserving?"""
3481
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3483
# first check truly case-preserving for created files, then check
3484
# case insensitive when opening existing files.
3485
name = osutils.normpath(name)
3486
base, rel = osutils.split(name)
3487
found_rel = osutils.canonical_relpath(base, name)
3488
return (found_rel == rel
3489
and os.path.isfile(name.upper())
3490
and os.path.isfile(name.lower()))
3495
def feature_name(self):
3496
return "case-insensitive case-preserving filesystem"
3498
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3501
class _CaseInsensitiveFilesystemFeature(Feature):
3502
"""Check if underlying filesystem is case-insensitive but *not* case
3505
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3506
# more likely to be case preserving, so this case is rare.
3509
if CaseInsCasePresFilenameFeature.available():
3512
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3513
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3514
TestCaseWithMemoryTransport.TEST_ROOT = root
3516
root = TestCaseWithMemoryTransport.TEST_ROOT
3517
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3519
name_a = osutils.pathjoin(tdir, 'a')
3520
name_A = osutils.pathjoin(tdir, 'A')
3522
result = osutils.isdir(name_A)
3523
_rmtree_temp_dir(tdir)
3526
def feature_name(self):
3527
return 'case-insensitive filesystem'
3529
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
