1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
# TODO: Perhaps there should be an API to find out if bzr running under the
20
# test suite -- some plugins might want to avoid making intrusive changes if
21
# this is the case. However, we want behaviour under to test to diverge as
22
# little as possible, so this should be used rarely if it's added at all.
23
# (Suggestion from j-a-meinel, 2005-11-24)
25
# NOTE: Some classes in here use camelCaseNaming() rather than
26
# underscore_naming(). That's for consistency with unittest; it's not the
27
# general style of bzrlib. Please continue that consistency when adding e.g.
28
# new assertFoo() methods.
18
33
from cStringIO import StringIO
30
from logging import debug, warning, error
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 2):
59
raise ImportError("need at least testtools 0.9.2: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
77
transport as _mod_transport,
32
81
import bzrlib.commands
82
import bzrlib.timestamp
84
import bzrlib.inventory
85
import bzrlib.iterablefile
90
# lsprof not available
92
from bzrlib.merge import merge_inner
95
from bzrlib.smart import client, request, server
97
from bzrlib import symbol_versioning
98
from bzrlib.symbol_versioning import (
33
105
import bzrlib.trace
34
import bzrlib.osutils as osutils
35
from bzrlib.selftest import TestUtil
36
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
37
from bzrlib.selftest.treeshape import build_tree_contents
38
from bzrlib.errors import BzrError
41
MODULES_TO_DOCTEST = []
45
class EarlyStoppingTestResultAdapter(object):
46
"""An adapter for TestResult to stop at the first first failure or error"""
48
def __init__(self, result):
51
def addError(self, test, err):
52
self._result.addError(test, err)
55
def addFailure(self, test, err):
56
self._result.addFailure(test, err)
59
def __getattr__(self, name):
60
return getattr(self._result, name)
62
def __setattr__(self, name, value):
64
object.__setattr__(self, name, value)
65
return setattr(self._result, name, value)
68
class _MyResult(unittest._TextTestResult):
72
No special behaviour for now.
75
def _elapsedTime(self):
76
return "(Took %.3fs)" % (time.time() - self._start_time)
106
from bzrlib.transport import (
110
from bzrlib.trace import mutter, note
111
from bzrlib.tests import (
116
from bzrlib.ui import NullProgressView
117
from bzrlib.ui.text import TextUIFactory
118
import bzrlib.version_info_formats.format_custom
119
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
121
# Mark this python module as being part of the implementation
122
# of unittest: this gives us better tracebacks where the last
123
# shown frame is the test code, not our assertXYZ.
126
default_transport = test_server.LocalURLServer
129
_unitialized_attr = object()
130
"""A sentinel needed to act as a default value in a method signature."""
133
# Subunit result codes, defined here to prevent a hard dependency on subunit.
137
# These are intentionally brought into this namespace. That way plugins, etc
138
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
139
TestSuite = TestUtil.TestSuite
140
TestLoader = TestUtil.TestLoader
142
class ExtendedTestResult(testtools.TextTestResult):
143
"""Accepts, reports and accumulates the results of running tests.
145
Compared to the unittest version this class adds support for
146
profiling, benchmarking, stopping as soon as a test fails, and
147
skipping tests. There are further-specialized subclasses for
148
different types of display.
150
When a test finishes, in whatever way, it calls one of the addSuccess,
151
addFailure or addError classes. These in turn may redirect to a more
152
specific case for the special test results supported by our extended
155
Note that just one of these objects is fed the results from many tests.
160
def __init__(self, stream, descriptions, verbosity,
164
"""Construct new TestResult.
166
:param bench_history: Optionally, a writable file object to accumulate
169
testtools.TextTestResult.__init__(self, stream)
170
if bench_history is not None:
171
from bzrlib.version import _get_bzr_source_tree
172
src_tree = _get_bzr_source_tree()
175
revision_id = src_tree.get_parent_ids()[0]
177
# XXX: if this is a brand new tree, do the same as if there
181
# XXX: If there's no branch, what should we do?
183
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
184
self._bench_history = bench_history
185
self.ui = ui.ui_factory
188
self.failure_count = 0
189
self.known_failure_count = 0
191
self.not_applicable_count = 0
192
self.unsupported = {}
194
self._overall_start_time = time.time()
195
self._strict = strict
196
self._first_thread_leaker_id = None
197
self._tests_leaking_threads_count = 0
198
self._traceback_from_test = None
200
def stopTestRun(self):
203
stopTime = time.time()
204
timeTaken = stopTime - self.startTime
205
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
206
# the parent class method is similar have to duplicate
207
self._show_list('ERROR', self.errors)
208
self._show_list('FAIL', self.failures)
209
self.stream.write(self.sep2)
210
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
211
run, run != 1 and "s" or "", timeTaken))
212
if not self.wasSuccessful():
213
self.stream.write("FAILED (")
214
failed, errored = map(len, (self.failures, self.errors))
216
self.stream.write("failures=%d" % failed)
218
if failed: self.stream.write(", ")
219
self.stream.write("errors=%d" % errored)
220
if self.known_failure_count:
221
if failed or errored: self.stream.write(", ")
222
self.stream.write("known_failure_count=%d" %
223
self.known_failure_count)
224
self.stream.write(")\n")
226
if self.known_failure_count:
227
self.stream.write("OK (known_failures=%d)\n" %
228
self.known_failure_count)
230
self.stream.write("OK\n")
231
if self.skip_count > 0:
232
skipped = self.skip_count
233
self.stream.write('%d test%s skipped\n' %
234
(skipped, skipped != 1 and "s" or ""))
236
for feature, count in sorted(self.unsupported.items()):
237
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
240
ok = self.wasStrictlySuccessful()
242
ok = self.wasSuccessful()
243
if self._first_thread_leaker_id:
245
'%s is leaking threads among %d leaking tests.\n' % (
246
self._first_thread_leaker_id,
247
self._tests_leaking_threads_count))
248
# We don't report the main thread as an active one.
250
'%d non-main threads were left active in the end.\n'
251
% (len(self._active_threads) - 1))
253
def getDescription(self, test):
256
def _extractBenchmarkTime(self, testCase, details=None):
257
"""Add a benchmark time for the current test case."""
258
if details and 'benchtime' in details:
259
return float(''.join(details['benchtime'].iter_bytes()))
260
return getattr(testCase, "_benchtime", None)
262
def _elapsedTestTimeString(self):
263
"""Return a time string for the overall time the current test has taken."""
264
return self._formatTime(self._delta_to_float(
265
self._now() - self._start_datetime))
267
def _testTimeString(self, testCase):
268
benchmark_time = self._extractBenchmarkTime(testCase)
269
if benchmark_time is not None:
270
return self._formatTime(benchmark_time) + "*"
272
return self._elapsedTestTimeString()
274
def _formatTime(self, seconds):
275
"""Format seconds as milliseconds with leading spaces."""
276
# some benchmarks can take thousands of seconds to run, so we need 8
278
return "%8dms" % (1000 * seconds)
280
def _shortened_test_description(self, test):
282
what = re.sub(r'^bzrlib\.tests\.', '', what)
285
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
286
# multiple times in a row, because the handler is added for
287
# each test but the container list is shared between cases.
288
# See lp:498869 lp:625574 and lp:637725 for background.
289
def _record_traceback_from_test(self, exc_info):
290
"""Store the traceback from passed exc_info tuple till"""
291
self._traceback_from_test = exc_info[2]
78
293
def startTest(self, test):
79
unittest.TestResult.startTest(self, test)
80
# TODO: Maybe show test.shortDescription somewhere?
81
what = test.shortDescription() or test.id()
83
self.stream.write('%-70.70s' % what)
85
self._start_time = time.time()
294
super(ExtendedTestResult, self).startTest(test)
298
self.report_test_start(test)
299
test.number = self.count
300
self._recordTestStartTime()
301
# Make testtools cases give us the real traceback on failure
302
addOnException = getattr(test, "addOnException", None)
303
if addOnException is not None:
304
addOnException(self._record_traceback_from_test)
305
# Only check for thread leaks if the test case supports cleanups
306
addCleanup = getattr(test, "addCleanup", None)
307
if addCleanup is not None:
308
addCleanup(self._check_leaked_threads, test)
310
def startTests(self):
311
self.report_tests_starting()
312
self._active_threads = threading.enumerate()
314
def stopTest(self, test):
315
self._traceback_from_test = None
317
def _check_leaked_threads(self, test):
318
"""See if any threads have leaked since last call
320
A sample of live threads is stored in the _active_threads attribute,
321
when this method runs it compares the current live threads and any not
322
in the previous sample are treated as having leaked.
324
now_active_threads = set(threading.enumerate())
325
threads_leaked = now_active_threads.difference(self._active_threads)
327
self._report_thread_leak(test, threads_leaked, now_active_threads)
328
self._tests_leaking_threads_count += 1
329
if self._first_thread_leaker_id is None:
330
self._first_thread_leaker_id = test.id()
331
self._active_threads = now_active_threads
333
def _recordTestStartTime(self):
334
"""Record that a test has started."""
335
self._start_datetime = self._now()
87
337
def addError(self, test, err):
88
unittest.TestResult.addError(self, test, err)
90
self.stream.writeln("ERROR %s" % self._elapsedTime())
92
self.stream.write('E')
338
"""Tell result that test finished with an error.
340
Called from the TestCase run() method when the test
341
fails with an unexpected error.
343
self._post_mortem(self._traceback_from_test)
344
super(ExtendedTestResult, self).addError(test, err)
345
self.error_count += 1
346
self.report_error(test, err)
95
350
def addFailure(self, test, err):
96
unittest.TestResult.addFailure(self, test, err)
98
self.stream.writeln("FAIL %s" % self._elapsedTime())
100
self.stream.write('F')
103
def addSuccess(self, test):
105
self.stream.writeln('OK %s' % self._elapsedTime())
107
self.stream.write('~')
109
unittest.TestResult.addSuccess(self, test)
111
def printErrorList(self, flavour, errors):
112
for test, err in errors:
113
self.stream.writeln(self.separator1)
114
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
115
if hasattr(test, '_get_log'):
116
self.stream.writeln()
117
self.stream.writeln('log from this test:')
118
print >>self.stream, test._get_log()
119
self.stream.writeln(self.separator2)
120
self.stream.writeln("%s" % err)
123
class TextTestRunner(unittest.TextTestRunner):
351
"""Tell result that test failed.
353
Called from the TestCase run() method when the test
354
fails because e.g. an assert() method failed.
356
self._post_mortem(self._traceback_from_test)
357
super(ExtendedTestResult, self).addFailure(test, err)
358
self.failure_count += 1
359
self.report_failure(test, err)
363
def addSuccess(self, test, details=None):
364
"""Tell result that test completed successfully.
366
Called from the TestCase run()
368
if self._bench_history is not None:
369
benchmark_time = self._extractBenchmarkTime(test, details)
370
if benchmark_time is not None:
371
self._bench_history.write("%s %s\n" % (
372
self._formatTime(benchmark_time),
374
self.report_success(test)
375
super(ExtendedTestResult, self).addSuccess(test)
376
test._log_contents = ''
378
def addExpectedFailure(self, test, err):
379
self.known_failure_count += 1
380
self.report_known_failure(test, err)
382
def addNotSupported(self, test, feature):
383
"""The test will not be run because of a missing feature.
385
# this can be called in two different ways: it may be that the
386
# test started running, and then raised (through requireFeature)
387
# UnavailableFeature. Alternatively this method can be called
388
# while probing for features before running the test code proper; in
389
# that case we will see startTest and stopTest, but the test will
390
# never actually run.
391
self.unsupported.setdefault(str(feature), 0)
392
self.unsupported[str(feature)] += 1
393
self.report_unsupported(test, feature)
395
def addSkip(self, test, reason):
396
"""A test has not run for 'reason'."""
398
self.report_skip(test, reason)
400
def addNotApplicable(self, test, reason):
401
self.not_applicable_count += 1
402
self.report_not_applicable(test, reason)
404
def _post_mortem(self, tb=None):
405
"""Start a PDB post mortem session."""
406
if os.environ.get('BZR_TEST_PDB', None):
410
def progress(self, offset, whence):
411
"""The test is adjusting the count of tests to run."""
412
if whence == SUBUNIT_SEEK_SET:
413
self.num_tests = offset
414
elif whence == SUBUNIT_SEEK_CUR:
415
self.num_tests += offset
417
raise errors.BzrError("Unknown whence %r" % whence)
419
def report_tests_starting(self):
420
"""Display information before the test run begins"""
421
if getattr(sys, 'frozen', None) is None:
422
bzr_path = osutils.realpath(sys.argv[0])
424
bzr_path = sys.executable
426
'bzr selftest: %s\n' % (bzr_path,))
429
bzrlib.__path__[0],))
431
' bzr-%s python-%s %s\n' % (
432
bzrlib.version_string,
433
bzrlib._format_version_tuple(sys.version_info),
434
platform.platform(aliased=1),
436
self.stream.write('\n')
438
def report_test_start(self, test):
439
"""Display information on the test just about to be run"""
441
def _report_thread_leak(self, test, leaked_threads, active_threads):
442
"""Display information on a test that leaked one or more threads"""
443
# GZ 2010-09-09: A leak summary reported separately from the general
444
# thread debugging would be nice. Tests under subunit
445
# need something not using stream, perhaps adding a
446
# testtools details object would be fitting.
447
if 'threads' in selftest_debug_flags:
448
self.stream.write('%s is leaking, active is now %d\n' %
449
(test.id(), len(active_threads)))
451
def startTestRun(self):
452
self.startTime = time.time()
454
def report_success(self, test):
457
def wasStrictlySuccessful(self):
458
if self.unsupported or self.known_failure_count:
460
return self.wasSuccessful()
463
class TextTestResult(ExtendedTestResult):
464
"""Displays progress and results of tests in text form"""
466
def __init__(self, stream, descriptions, verbosity,
471
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
472
bench_history, strict)
473
# We no longer pass them around, but just rely on the UIFactory stack
476
warnings.warn("Passing pb to TextTestResult is deprecated")
477
self.pb = self.ui.nested_progress_bar()
478
self.pb.show_pct = False
479
self.pb.show_spinner = False
480
self.pb.show_eta = False,
481
self.pb.show_count = False
482
self.pb.show_bar = False
483
self.pb.update_latency = 0
484
self.pb.show_transport_activity = False
486
def stopTestRun(self):
487
# called when the tests that are going to run have run
490
super(TextTestResult, self).stopTestRun()
492
def report_tests_starting(self):
493
super(TextTestResult, self).report_tests_starting()
494
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
496
def _progress_prefix_text(self):
497
# the longer this text, the less space we have to show the test
499
a = '[%d' % self.count # total that have been run
500
# tests skipped as known not to be relevant are not important enough
502
## if self.skip_count:
503
## a += ', %d skip' % self.skip_count
504
## if self.known_failure_count:
505
## a += '+%dX' % self.known_failure_count
507
a +='/%d' % self.num_tests
509
runtime = time.time() - self._overall_start_time
511
a += '%dm%ds' % (runtime / 60, runtime % 60)
514
total_fail_count = self.error_count + self.failure_count
516
a += ', %d failed' % total_fail_count
517
# if self.unsupported:
518
# a += ', %d missing' % len(self.unsupported)
522
def report_test_start(self, test):
524
self._progress_prefix_text()
526
+ self._shortened_test_description(test))
528
def _test_description(self, test):
529
return self._shortened_test_description(test)
531
def report_error(self, test, err):
532
self.stream.write('ERROR: %s\n %s\n' % (
533
self._test_description(test),
537
def report_failure(self, test, err):
538
self.stream.write('FAIL: %s\n %s\n' % (
539
self._test_description(test),
543
def report_known_failure(self, test, err):
546
def report_skip(self, test, reason):
549
def report_not_applicable(self, test, reason):
552
def report_unsupported(self, test, feature):
553
"""test cannot be run because feature is missing."""
556
class VerboseTestResult(ExtendedTestResult):
557
"""Produce long output, with one line per test run plus times"""
559
def _ellipsize_to_right(self, a_string, final_width):
560
"""Truncate and pad a string, keeping the right hand side"""
561
if len(a_string) > final_width:
562
result = '...' + a_string[3-final_width:]
565
return result.ljust(final_width)
567
def report_tests_starting(self):
568
self.stream.write('running %d tests...\n' % self.num_tests)
569
super(VerboseTestResult, self).report_tests_starting()
571
def report_test_start(self, test):
572
name = self._shortened_test_description(test)
573
width = osutils.terminal_width()
574
if width is not None:
575
# width needs space for 6 char status, plus 1 for slash, plus an
576
# 11-char time string, plus a trailing blank
577
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
579
self.stream.write(self._ellipsize_to_right(name, width-18))
581
self.stream.write(name)
584
def _error_summary(self, err):
586
return '%s%s' % (indent, err[1])
588
def report_error(self, test, err):
589
self.stream.write('ERROR %s\n%s\n'
590
% (self._testTimeString(test),
591
self._error_summary(err)))
593
def report_failure(self, test, err):
594
self.stream.write(' FAIL %s\n%s\n'
595
% (self._testTimeString(test),
596
self._error_summary(err)))
598
def report_known_failure(self, test, err):
599
self.stream.write('XFAIL %s\n%s\n'
600
% (self._testTimeString(test),
601
self._error_summary(err)))
603
def report_success(self, test):
604
self.stream.write(' OK %s\n' % self._testTimeString(test))
605
for bench_called, stats in getattr(test, '_benchcalls', []):
606
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
607
stats.pprint(file=self.stream)
608
# flush the stream so that we get smooth output. This verbose mode is
609
# used to show the output in PQM.
612
def report_skip(self, test, reason):
613
self.stream.write(' SKIP %s\n%s\n'
614
% (self._testTimeString(test), reason))
616
def report_not_applicable(self, test, reason):
617
self.stream.write(' N/A %s\n %s\n'
618
% (self._testTimeString(test), reason))
620
def report_unsupported(self, test, feature):
621
"""test cannot be run because feature is missing."""
622
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
623
%(self._testTimeString(test), feature))
626
class TextTestRunner(object):
124
627
stop_on_failure = False
126
def _makeResult(self):
127
result = _MyResult(self.stream, self.descriptions, self.verbosity)
128
if self.stop_on_failure:
129
result = EarlyStoppingTestResultAdapter(result)
635
result_decorators=None,
637
"""Create a TextTestRunner.
639
:param result_decorators: An optional list of decorators to apply
640
to the result object being used by the runner. Decorators are
641
applied left to right - the first element in the list is the
644
# stream may know claim to know to write unicode strings, but in older
645
# pythons this goes sufficiently wrong that it is a bad idea. (
646
# specifically a built in file with encoding 'UTF-8' will still try
647
# to encode using ascii.
648
new_encoding = osutils.get_terminal_encoding()
649
codec = codecs.lookup(new_encoding)
650
if type(codec) is tuple:
654
encode = codec.encode
655
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
656
stream.encoding = new_encoding
658
self.descriptions = descriptions
659
self.verbosity = verbosity
660
self._bench_history = bench_history
661
self._strict = strict
662
self._result_decorators = result_decorators or []
665
"Run the given test case or test suite."
666
if self.verbosity == 1:
667
result_class = TextTestResult
668
elif self.verbosity >= 2:
669
result_class = VerboseTestResult
670
original_result = result_class(self.stream,
673
bench_history=self._bench_history,
676
# Signal to result objects that look at stop early policy to stop,
677
original_result.stop_early = self.stop_on_failure
678
result = original_result
679
for decorator in self._result_decorators:
680
result = decorator(result)
681
result.stop_early = self.stop_on_failure
682
result.startTestRun()
687
# higher level code uses our extended protocol to determine
688
# what exit code to give.
689
return original_result
133
692
def iter_suite_tests(suite):
134
693
"""Return all tests in a suite, recursing through nested suites"""
135
for item in suite._tests:
136
if isinstance(item, unittest.TestCase):
138
elif isinstance(item, unittest.TestSuite):
694
if isinstance(suite, unittest.TestCase):
696
elif isinstance(suite, unittest.TestSuite):
139
698
for r in iter_suite_tests(item):
142
raise Exception('unknown object %r inside test suite %r'
146
class TestSkipped(Exception):
147
"""Indicates that a test was intentionally skipped, rather than failing."""
151
class CommandFailed(Exception):
154
class TestCase(unittest.TestCase):
701
raise Exception('unknown type %r for object %r'
702
% (type(suite), suite))
705
TestSkipped = testtools.testcase.TestSkipped
708
class TestNotApplicable(TestSkipped):
709
"""A test is not applicable to the situation where it was run.
711
This is only normally raised by parameterized tests, if they find that
712
the instance they're constructed upon does not support one aspect
717
# traceback._some_str fails to format exceptions that have the default
718
# __str__ which does an implicit ascii conversion. However, repr() on those
719
# objects works, for all that its not quite what the doctor may have ordered.
720
def _clever_some_str(value):
725
return repr(value).replace('\\n', '\n')
727
return '<unprintable %s object>' % type(value).__name__
729
traceback._some_str = _clever_some_str
732
# deprecated - use self.knownFailure(), or self.expectFailure.
733
KnownFailure = testtools.testcase._ExpectedFailure
736
class UnavailableFeature(Exception):
737
"""A feature required for this test was not available.
739
This can be considered a specialised form of SkippedTest.
741
The feature should be used to construct the exception.
745
class StringIOWrapper(object):
746
"""A wrapper around cStringIO which just adds an encoding attribute.
748
Internally we can check sys.stdout to see what the output encoding
749
should be. However, cStringIO has no encoding attribute that we can
750
set. So we wrap it instead.
755
def __init__(self, s=None):
757
self.__dict__['_cstring'] = StringIO(s)
759
self.__dict__['_cstring'] = StringIO()
761
def __getattr__(self, name, getattr=getattr):
762
return getattr(self.__dict__['_cstring'], name)
764
def __setattr__(self, name, val):
765
if name == 'encoding':
766
self.__dict__['encoding'] = val
768
return setattr(self._cstring, name, val)
771
class TestUIFactory(TextUIFactory):
772
"""A UI Factory for testing.
774
Hide the progress bar but emit note()s.
776
Allows get_password to be tested without real tty attached.
778
See also CannedInputUIFactory which lets you provide programmatic input in
781
# TODO: Capture progress events at the model level and allow them to be
782
# observed by tests that care.
784
# XXX: Should probably unify more with CannedInputUIFactory or a
785
# particular configuration of TextUIFactory, or otherwise have a clearer
786
# idea of how they're supposed to be different.
787
# See https://bugs.launchpad.net/bzr/+bug/408213
789
def __init__(self, stdout=None, stderr=None, stdin=None):
790
if stdin is not None:
791
# We use a StringIOWrapper to be able to test various
792
# encodings, but the user is still responsible to
793
# encode the string and to set the encoding attribute
794
# of StringIOWrapper.
795
stdin = StringIOWrapper(stdin)
796
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
798
def get_non_echoed_password(self):
799
"""Get password from stdin without trying to handle the echo mode"""
800
password = self.stdin.readline()
803
if password[-1] == '\n':
804
password = password[:-1]
807
def make_progress_view(self):
808
return NullProgressView()
811
class TestCase(testtools.TestCase):
155
812
"""Base class for bzr unit tests.
157
Tests that need access to disk resources should subclass
814
Tests that need access to disk resources should subclass
158
815
TestCaseInTempDir not TestCase.
160
817
Error and debug log messages are redirected from their usual
198
1117
charjunk=lambda x: False)
199
1118
return ''.join(difflines)
201
def assertEqualDiff(self, a, b):
1120
def assertEqual(self, a, b, message=''):
1124
except UnicodeError, e:
1125
# If we can't compare without getting a UnicodeError, then
1126
# obviously they are different
1127
mutter('UnicodeError: %s', e)
1130
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1132
pprint.pformat(a), pprint.pformat(b)))
1134
assertEquals = assertEqual
1136
def assertEqualDiff(self, a, b, message=None):
202
1137
"""Assert two texts are equal, if not raise an exception.
204
This is intended for use with multi-line strings where it can
1139
This is intended for use with multi-line strings where it can
205
1140
be hard to find the differences by eye.
207
1142
# TODO: perhaps override assertEquals to call this for strings?
210
raise AssertionError("texts not equal:\n" +
211
self._ndiff_strings(a, b))
213
def assertContainsRe(self, haystack, needle_re):
1146
message = "texts not equal:\n"
1148
message = 'first string is missing a final newline.\n'
1150
message = 'second string is missing a final newline.\n'
1151
raise AssertionError(message +
1152
self._ndiff_strings(a, b))
1154
def assertEqualMode(self, mode, mode_test):
1155
self.assertEqual(mode, mode_test,
1156
'mode mismatch %o != %o' % (mode, mode_test))
1158
def assertEqualStat(self, expected, actual):
1159
"""assert that expected and actual are the same stat result.
1161
:param expected: A stat result.
1162
:param actual: A stat result.
1163
:raises AssertionError: If the expected and actual stat values differ
1164
other than by atime.
1166
self.assertEqual(expected.st_size, actual.st_size,
1167
'st_size did not match')
1168
self.assertEqual(expected.st_mtime, actual.st_mtime,
1169
'st_mtime did not match')
1170
self.assertEqual(expected.st_ctime, actual.st_ctime,
1171
'st_ctime did not match')
1172
if sys.platform != 'win32':
1173
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1174
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1175
# odd. Regardless we shouldn't actually try to assert anything
1176
# about their values
1177
self.assertEqual(expected.st_dev, actual.st_dev,
1178
'st_dev did not match')
1179
self.assertEqual(expected.st_ino, actual.st_ino,
1180
'st_ino did not match')
1181
self.assertEqual(expected.st_mode, actual.st_mode,
1182
'st_mode did not match')
1184
def assertLength(self, length, obj_with_len):
1185
"""Assert that obj_with_len is of length length."""
1186
if len(obj_with_len) != length:
1187
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1188
length, len(obj_with_len), obj_with_len))
1190
def assertLogsError(self, exception_class, func, *args, **kwargs):
1191
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1193
from bzrlib import trace
1195
orig_log_exception_quietly = trace.log_exception_quietly
1198
orig_log_exception_quietly()
1199
captured.append(sys.exc_info())
1200
trace.log_exception_quietly = capture
1201
func(*args, **kwargs)
1203
trace.log_exception_quietly = orig_log_exception_quietly
1204
self.assertLength(1, captured)
1205
err = captured[0][1]
1206
self.assertIsInstance(err, exception_class)
1209
def assertPositive(self, val):
1210
"""Assert that val is greater than 0."""
1211
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1213
def assertNegative(self, val):
1214
"""Assert that val is less than 0."""
1215
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1217
def assertStartsWith(self, s, prefix):
1218
if not s.startswith(prefix):
1219
raise AssertionError('string %r does not start with %r' % (s, prefix))
1221
def assertEndsWith(self, s, suffix):
1222
"""Asserts that s ends with suffix."""
1223
if not s.endswith(suffix):
1224
raise AssertionError('string %r does not end with %r' % (s, suffix))
1226
def assertContainsRe(self, haystack, needle_re, flags=0):
214
1227
"""Assert that a contains something matching a regular expression."""
215
if not re.search(needle_re, haystack):
216
raise AssertionError('pattern "%s" not found in "%s"'
1228
if not re.search(needle_re, haystack, flags):
1229
if '\n' in haystack or len(haystack) > 60:
1230
# a long string, format it in a more readable way
1231
raise AssertionError(
1232
'pattern "%s" not found in\n"""\\\n%s"""\n'
1233
% (needle_re, haystack))
1235
raise AssertionError('pattern "%s" not found in "%s"'
1236
% (needle_re, haystack))
1238
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1239
"""Assert that a does not match a regular expression"""
1240
if re.search(needle_re, haystack, flags):
1241
raise AssertionError('pattern "%s" found in "%s"'
217
1242
% (needle_re, haystack))
1244
def assertContainsString(self, haystack, needle):
1245
if haystack.find(needle) == -1:
1246
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1248
def assertSubset(self, sublist, superlist):
1249
"""Assert that every entry in sublist is present in superlist."""
1250
missing = set(sublist) - set(superlist)
1251
if len(missing) > 0:
1252
raise AssertionError("value(s) %r not present in container %r" %
1253
(missing, superlist))
1255
def assertListRaises(self, excClass, func, *args, **kwargs):
1256
"""Fail unless excClass is raised when the iterator from func is used.
1258
Many functions can return generators this makes sure
1259
to wrap them in a list() call to make sure the whole generator
1260
is run, and that the proper exception is raised.
1263
list(func(*args, **kwargs))
1267
if getattr(excClass,'__name__', None) is not None:
1268
excName = excClass.__name__
1270
excName = str(excClass)
1271
raise self.failureException, "%s not raised" % excName
1273
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1274
"""Assert that a callable raises a particular exception.
1276
:param excClass: As for the except statement, this may be either an
1277
exception class, or a tuple of classes.
1278
:param callableObj: A callable, will be passed ``*args`` and
1281
Returns the exception so that you can examine it.
1284
callableObj(*args, **kwargs)
1288
if getattr(excClass,'__name__', None) is not None:
1289
excName = excClass.__name__
1292
excName = str(excClass)
1293
raise self.failureException, "%s not raised" % excName
1295
def assertIs(self, left, right, message=None):
1296
if not (left is right):
1297
if message is not None:
1298
raise AssertionError(message)
1300
raise AssertionError("%r is not %r." % (left, right))
1302
def assertIsNot(self, left, right, message=None):
1304
if message is not None:
1305
raise AssertionError(message)
1307
raise AssertionError("%r is %r." % (left, right))
1309
def assertTransportMode(self, transport, path, mode):
1310
"""Fail if a path does not have mode "mode".
1312
If modes are not supported on this transport, the assertion is ignored.
1314
if not transport._can_roundtrip_unix_modebits():
1316
path_stat = transport.stat(path)
1317
actual_mode = stat.S_IMODE(path_stat.st_mode)
1318
self.assertEqual(mode, actual_mode,
1319
'mode of %r incorrect (%s != %s)'
1320
% (path, oct(mode), oct(actual_mode)))
1322
def assertIsSameRealPath(self, path1, path2):
1323
"""Fail if path1 and path2 points to different files"""
1324
self.assertEqual(osutils.realpath(path1),
1325
osutils.realpath(path2),
1326
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1328
def assertIsInstance(self, obj, kls, msg=None):
1329
"""Fail if obj is not an instance of kls
1331
:param msg: Supplementary message to show if the assertion fails.
1333
if not isinstance(obj, kls):
1334
m = "%r is an instance of %s rather than %s" % (
1335
obj, obj.__class__, kls)
1340
def assertFileEqual(self, content, path):
1341
"""Fail if path does not contain 'content'."""
1342
self.failUnlessExists(path)
1343
f = file(path, 'rb')
1348
self.assertEqualDiff(content, s)
1350
def assertDocstring(self, expected_docstring, obj):
1351
"""Fail if obj does not have expected_docstring"""
1353
# With -OO the docstring should be None instead
1354
self.assertIs(obj.__doc__, None)
1356
self.assertEqual(expected_docstring, obj.__doc__)
1358
def failUnlessExists(self, path):
1359
"""Fail unless path or paths, which may be abs or relative, exist."""
1360
if not isinstance(path, basestring):
1362
self.failUnlessExists(p)
1364
self.failUnless(osutils.lexists(path),path+" does not exist")
1366
def failIfExists(self, path):
1367
"""Fail if path or paths, which may be abs or relative, exist."""
1368
if not isinstance(path, basestring):
1370
self.failIfExists(p)
1372
self.failIf(osutils.lexists(path),path+" exists")
1374
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1375
"""A helper for callDeprecated and applyDeprecated.
1377
:param a_callable: A callable to call.
1378
:param args: The positional arguments for the callable
1379
:param kwargs: The keyword arguments for the callable
1380
:return: A tuple (warnings, result). result is the result of calling
1381
a_callable(``*args``, ``**kwargs``).
1384
def capture_warnings(msg, cls=None, stacklevel=None):
1385
# we've hooked into a deprecation specific callpath,
1386
# only deprecations should getting sent via it.
1387
self.assertEqual(cls, DeprecationWarning)
1388
local_warnings.append(msg)
1389
original_warning_method = symbol_versioning.warn
1390
symbol_versioning.set_warning_method(capture_warnings)
1392
result = a_callable(*args, **kwargs)
1394
symbol_versioning.set_warning_method(original_warning_method)
1395
return (local_warnings, result)
1397
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1398
"""Call a deprecated callable without warning the user.
1400
Note that this only captures warnings raised by symbol_versioning.warn,
1401
not other callers that go direct to the warning module.
1403
To test that a deprecated method raises an error, do something like
1406
self.assertRaises(errors.ReservedId,
1407
self.applyDeprecated,
1408
deprecated_in((1, 5, 0)),
1412
:param deprecation_format: The deprecation format that the callable
1413
should have been deprecated with. This is the same type as the
1414
parameter to deprecated_method/deprecated_function. If the
1415
callable is not deprecated with this format, an assertion error
1417
:param a_callable: A callable to call. This may be a bound method or
1418
a regular function. It will be called with ``*args`` and
1420
:param args: The positional arguments for the callable
1421
:param kwargs: The keyword arguments for the callable
1422
:return: The result of a_callable(``*args``, ``**kwargs``)
1424
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1426
expected_first_warning = symbol_versioning.deprecation_string(
1427
a_callable, deprecation_format)
1428
if len(call_warnings) == 0:
1429
self.fail("No deprecation warning generated by call to %s" %
1431
self.assertEqual(expected_first_warning, call_warnings[0])
1434
def callCatchWarnings(self, fn, *args, **kw):
1435
"""Call a callable that raises python warnings.
1437
The caller's responsible for examining the returned warnings.
1439
If the callable raises an exception, the exception is not
1440
caught and propagates up to the caller. In that case, the list
1441
of warnings is not available.
1443
:returns: ([warning_object, ...], fn_result)
1445
# XXX: This is not perfect, because it completely overrides the
1446
# warnings filters, and some code may depend on suppressing particular
1447
# warnings. It's the easiest way to insulate ourselves from -Werror,
1448
# though. -- Andrew, 20071062
1450
def _catcher(message, category, filename, lineno, file=None, line=None):
1451
# despite the name, 'message' is normally(?) a Warning subclass
1453
wlist.append(message)
1454
saved_showwarning = warnings.showwarning
1455
saved_filters = warnings.filters
1457
warnings.showwarning = _catcher
1458
warnings.filters = []
1459
result = fn(*args, **kw)
1461
warnings.showwarning = saved_showwarning
1462
warnings.filters = saved_filters
1463
return wlist, result
1465
def callDeprecated(self, expected, callable, *args, **kwargs):
1466
"""Assert that a callable is deprecated in a particular way.
1468
This is a very precise test for unusual requirements. The
1469
applyDeprecated helper function is probably more suited for most tests
1470
as it allows you to simply specify the deprecation format being used
1471
and will ensure that that is issued for the function being called.
1473
Note that this only captures warnings raised by symbol_versioning.warn,
1474
not other callers that go direct to the warning module. To catch
1475
general warnings, use callCatchWarnings.
1477
:param expected: a list of the deprecation warnings expected, in order
1478
:param callable: The callable to call
1479
:param args: The positional arguments for the callable
1480
:param kwargs: The keyword arguments for the callable
1482
call_warnings, result = self._capture_deprecation_warnings(callable,
1484
self.assertEqual(expected, call_warnings)
219
1487
def _startLogFile(self):
220
1488
"""Send bzr and test log messages to a temporary file.
222
1490
The file is removed as the test is torn down.
224
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
225
self._log_file = os.fdopen(fileno, 'w+')
226
bzrlib.trace.enable_test_log(self._log_file)
227
debug('opened log file %s', name)
228
self._log_file_name = name
1492
self._log_file = StringIO()
1493
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
229
1494
self.addCleanup(self._finishLogFile)
231
1496
def _finishLogFile(self):
232
1497
"""Finished with the log file.
234
Read contents into memory, close, and delete.
236
bzrlib.trace.disable_test_log()
237
self._log_file.seek(0)
238
self._log_contents = self._log_file.read()
239
self._log_file.close()
240
os.remove(self._log_file_name)
241
self._log_file = self._log_file_name = None
243
def addCleanup(self, callable):
244
"""Arrange to run a callable when this case is torn down.
246
Callables are run in the reverse of the order they are registered,
247
ie last-in first-out.
249
if callable in self._cleanups:
250
raise ValueError("cleanup function %r already registered on %s"
252
self._cleanups.append(callable)
1499
Close the file and delete it, unless setKeepLogfile was called.
1501
if bzrlib.trace._trace_file:
1502
# flush the log file, to get all content
1503
bzrlib.trace._trace_file.flush()
1504
bzrlib.trace.pop_log_file(self._log_memento)
1505
# Cache the log result and delete the file on disk
1506
self._get_log(False)
1508
def thisFailsStrictLockCheck(self):
1509
"""It is known that this test would fail with -Dstrict_locks.
1511
By default, all tests are run with strict lock checking unless
1512
-Edisable_lock_checks is supplied. However there are some tests which
1513
we know fail strict locks at this point that have not been fixed.
1514
They should call this function to disable the strict checking.
1516
This should be used sparingly, it is much better to fix the locking
1517
issues rather than papering over the problem by calling this function.
1519
debug.debug_flags.discard('strict_locks')
1521
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1522
"""Overrides an object attribute restoring it after the test.
1524
:param obj: The object that will be mutated.
1526
:param attr_name: The attribute name we want to preserve/override in
1529
:param new: The optional value we want to set the attribute to.
1531
:returns: The actual attr value.
1533
value = getattr(obj, attr_name)
1534
# The actual value is captured by the call below
1535
self.addCleanup(setattr, obj, attr_name, value)
1536
if new is not _unitialized_attr:
1537
setattr(obj, attr_name, new)
254
1540
def _cleanEnvironment(self):
1542
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
256
1543
'HOME': os.getcwd(),
257
'APPDATA': os.getcwd(),
1544
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1545
# tests do check our impls match APPDATA
1546
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1550
'BZREMAIL': None, # may still be present in the environment
1551
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1552
'BZR_PROGRESS_BAR': None,
1554
'BZR_PLUGIN_PATH': None,
1555
'BZR_DISABLE_PLUGINS': None,
1556
'BZR_PLUGINS_AT': None,
1557
'BZR_CONCURRENCY': None,
1558
# Make sure that any text ui tests are consistent regardless of
1559
# the environment the test case is run in; you may want tests that
1560
# test other combinations. 'dumb' is a reasonable guess for tests
1561
# going to a pipe or a StringIO.
1565
'BZR_COLUMNS': '80',
1567
'SSH_AUTH_SOCK': None,
1571
'https_proxy': None,
1572
'HTTPS_PROXY': None,
1577
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1578
# least. If you do (care), please update this comment
1582
'BZR_REMOTE_PATH': None,
1583
# Generally speaking, we don't want apport reporting on crashes in
1584
# the test envirnoment unless we're specifically testing apport,
1585
# so that it doesn't leak into the real system environment. We
1586
# use an env var so it propagates to subprocesses.
1587
'APPORT_DISABLE': '1',
262
1590
self.addCleanup(self._restoreEnvironment)
263
1591
for name, value in new_env.iteritems():
264
1592
self._captureVar(name, value)
267
1594
def _captureVar(self, name, newvalue):
268
"""Set an environment variable, preparing it to be reset when finished."""
269
self.__old_env[name] = os.environ.get(name, None)
271
if name in os.environ:
274
os.environ[name] = newvalue
277
def _restoreVar(name, value):
279
if name in os.environ:
282
os.environ[name] = value
1595
"""Set an environment variable, and reset it when finished."""
1596
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
284
1598
def _restoreEnvironment(self):
285
for name, value in self.__old_env.iteritems():
286
self._restoreVar(name, value)
290
unittest.TestCase.tearDown(self)
292
def _runCleanups(self):
293
"""Run registered cleanup functions.
295
This should only be called from TestCase.tearDown.
297
for callable in reversed(self._cleanups):
1599
for name, value in self._old_env.iteritems():
1600
osutils.set_or_unset_env(name, value)
1602
def _restoreHooks(self):
1603
for klass, (name, hooks) in self._preserved_hooks.items():
1604
setattr(klass, name, hooks)
1606
def knownFailure(self, reason):
1607
"""This test has failed for some known reason."""
1608
raise KnownFailure(reason)
1610
def _suppress_log(self):
1611
"""Remove the log info from details."""
1612
self.discardDetail('log')
1614
def _do_skip(self, result, reason):
1615
self._suppress_log()
1616
addSkip = getattr(result, 'addSkip', None)
1617
if not callable(addSkip):
1618
result.addSuccess(result)
1620
addSkip(self, reason)
1623
def _do_known_failure(self, result, e):
1624
self._suppress_log()
1625
err = sys.exc_info()
1626
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1627
if addExpectedFailure is not None:
1628
addExpectedFailure(self, err)
1630
result.addSuccess(self)
1633
def _do_not_applicable(self, result, e):
1635
reason = 'No reason given'
1638
self._suppress_log ()
1639
addNotApplicable = getattr(result, 'addNotApplicable', None)
1640
if addNotApplicable is not None:
1641
result.addNotApplicable(self, reason)
1643
self._do_skip(result, reason)
1646
def _report_skip(self, result, err):
1647
"""Override the default _report_skip.
1649
We want to strip the 'log' detail. If we waint until _do_skip, it has
1650
already been formatted into the 'reason' string, and we can't pull it
1653
self._suppress_log()
1654
super(TestCase, self)._report_skip(self, result, err)
1657
def _report_expected_failure(self, result, err):
1660
See _report_skip for motivation.
1662
self._suppress_log()
1663
super(TestCase, self)._report_expected_failure(self, result, err)
1666
def _do_unsupported_or_skip(self, result, e):
1668
self._suppress_log()
1669
addNotSupported = getattr(result, 'addNotSupported', None)
1670
if addNotSupported is not None:
1671
result.addNotSupported(self, reason)
1673
self._do_skip(result, reason)
1675
def time(self, callable, *args, **kwargs):
1676
"""Run callable and accrue the time it takes to the benchmark time.
1678
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1679
this will cause lsprofile statistics to be gathered and stored in
1682
if self._benchtime is None:
1683
self.addDetail('benchtime', content.Content(content.ContentType(
1684
"text", "plain"), lambda:[str(self._benchtime)]))
1688
if not self._gather_lsprof_in_benchmarks:
1689
return callable(*args, **kwargs)
1691
# record this benchmark
1692
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1694
self._benchcalls.append(((callable, args, kwargs), stats))
1697
self._benchtime += time.time() - start
300
1699
def log(self, *args):
304
"""Return as a string the log for this test"""
305
if self._log_file_name:
306
return open(self._log_file_name).read()
1702
def _get_log(self, keep_log_file=False):
1703
"""Internal helper to get the log from bzrlib.trace for this test.
1705
Please use self.getDetails, or self.get_log to access this in test case
1708
:param keep_log_file: When True, if the log is still a file on disk
1709
leave it as a file on disk. When False, if the log is still a file
1710
on disk, the log file is deleted and the log preserved as
1712
:return: A string containing the log.
1714
if self._log_contents is not None:
1716
self._log_contents.decode('utf8')
1717
except UnicodeDecodeError:
1718
unicodestr = self._log_contents.decode('utf8', 'replace')
1719
self._log_contents = unicodestr.encode('utf8')
308
1720
return self._log_contents
310
def capture(self, cmd, retcode=0):
311
"""Shortcut that splits cmd into words, runs, and returns stdout"""
312
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
314
def run_bzr_captured(self, argv, retcode=0):
315
"""Invoke bzr and return (stdout, stderr).
317
Useful for code that wants to check the contents of the
318
output, the way error messages are presented, etc.
320
This should be the main method for tests that want to exercise the
321
overall behavior of the bzr application (rather than a unit test
322
or a functional test of the library.)
324
Much of the old code runs bzr by forking a new copy of Python, but
325
that is slower, harder to debug, and generally not necessary.
327
This runs bzr through the interface that catches and reports
328
errors, and with logging set to something approximating the
329
default, so that error reporting can be checked.
331
argv -- arguments to invoke bzr
332
retcode -- expected return code, or None for don't-care.
336
self.log('run bzr: %s', ' '.join(argv))
1721
if self._log_file is not None:
1722
log_contents = self._log_file.getvalue()
1724
log_contents.decode('utf8')
1725
except UnicodeDecodeError:
1726
unicodestr = log_contents.decode('utf8', 'replace')
1727
log_contents = unicodestr.encode('utf8')
1728
if not keep_log_file:
1729
self._log_file = None
1730
# Permit multiple calls to get_log until we clean it up in
1732
self._log_contents = log_contents
1735
return "No log file content."
1738
"""Get a unicode string containing the log from bzrlib.trace.
1740
Undecodable characters are replaced.
1742
return u"".join(self.getDetails()['log'].iter_text())
1744
def requireFeature(self, feature):
1745
"""This test requires a specific feature is available.
1747
:raises UnavailableFeature: When feature is not available.
1749
if not feature.available():
1750
raise UnavailableFeature(feature)
1752
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1754
"""Run bazaar command line, splitting up a string command line."""
1755
if isinstance(args, basestring):
1756
# shlex don't understand unicode strings,
1757
# so args should be plain string (bialix 20070906)
1758
args = list(shlex.split(str(args)))
1759
return self._run_bzr_core(args, retcode=retcode,
1760
encoding=encoding, stdin=stdin, working_dir=working_dir,
1763
def _run_bzr_core(self, args, retcode, encoding, stdin,
1765
# Clear chk_map page cache, because the contents are likely to mask
1767
chk_map.clear_cache()
1768
if encoding is None:
1769
encoding = osutils.get_user_encoding()
1770
stdout = StringIOWrapper()
1771
stderr = StringIOWrapper()
1772
stdout.encoding = encoding
1773
stderr.encoding = encoding
1775
self.log('run bzr: %r', args)
1776
# FIXME: don't call into logging here
337
1777
handler = logging.StreamHandler(stderr)
338
handler.setFormatter(bzrlib.trace.QuietFormatter())
339
1778
handler.setLevel(logging.INFO)
340
1779
logger = logging.getLogger('')
341
1780
logger.addHandler(handler)
1781
old_ui_factory = ui.ui_factory
1782
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1785
if working_dir is not None:
1786
cwd = osutils.getcwd()
1787
os.chdir(working_dir)
343
result = self.apply_redirected(None, stdout, stderr,
344
bzrlib.commands.run_bzr_catch_errors,
1791
result = self.apply_redirected(ui.ui_factory.stdin,
1793
bzrlib.commands.run_bzr_catch_user_errors,
1795
except KeyboardInterrupt:
1796
# Reraise KeyboardInterrupt with contents of redirected stdout
1797
# and stderr as arguments, for tests which are interested in
1798
# stdout and stderr and are expecting the exception.
1799
out = stdout.getvalue()
1800
err = stderr.getvalue()
1802
self.log('output:\n%r', out)
1804
self.log('errors:\n%r', err)
1805
raise KeyboardInterrupt(out, err)
347
1807
logger.removeHandler(handler)
1808
ui.ui_factory = old_ui_factory
348
1812
out = stdout.getvalue()
349
1813
err = stderr.getvalue()
351
self.log('output:\n%s', out)
1815
self.log('output:\n%r', out)
353
self.log('errors:\n%s', err)
1817
self.log('errors:\n%r', err)
354
1818
if retcode is not None:
355
self.assertEquals(result, retcode)
1819
self.assertEquals(retcode, result,
1820
message='Unexpected return code')
1821
return result, out, err
358
def run_bzr(self, *args, **kwargs):
1823
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1824
working_dir=None, error_regexes=[], output_encoding=None):
359
1825
"""Invoke bzr, as if it were run from the command line.
1827
The argument list should not include the bzr program name - the
1828
first argument is normally the bzr command. Arguments may be
1829
passed in three ways:
1831
1- A list of strings, eg ["commit", "a"]. This is recommended
1832
when the command contains whitespace or metacharacters, or
1833
is built up at run time.
1835
2- A single string, eg "add a". This is the most convenient
1836
for hardcoded commands.
1838
This runs bzr through the interface that catches and reports
1839
errors, and with logging set to something approximating the
1840
default, so that error reporting can be checked.
361
1842
This should be the main method for tests that want to exercise the
362
1843
overall behavior of the bzr application (rather than a unit test
363
1844
or a functional test of the library.)
365
1846
This sends the stdout/stderr results into the test's log,
366
1847
where it may be useful for debugging. See also run_captured.
368
retcode = kwargs.pop('retcode', 0)
369
return self.run_bzr_captured(args, retcode)
1849
:keyword stdin: A string to be used as stdin for the command.
1850
:keyword retcode: The status code the command should return;
1852
:keyword working_dir: The directory to run the command in
1853
:keyword error_regexes: A list of expected error messages. If
1854
specified they must be seen in the error output of the command.
1856
retcode, out, err = self._run_bzr_autosplit(
1861
working_dir=working_dir,
1863
self.assertIsInstance(error_regexes, (list, tuple))
1864
for regex in error_regexes:
1865
self.assertContainsRe(err, regex)
1868
def run_bzr_error(self, error_regexes, *args, **kwargs):
1869
"""Run bzr, and check that stderr contains the supplied regexes
1871
:param error_regexes: Sequence of regular expressions which
1872
must each be found in the error output. The relative ordering
1874
:param args: command-line arguments for bzr
1875
:param kwargs: Keyword arguments which are interpreted by run_bzr
1876
This function changes the default value of retcode to be 3,
1877
since in most cases this is run when you expect bzr to fail.
1879
:return: (out, err) The actual output of running the command (in case
1880
you want to do more inspection)
1884
# Make sure that commit is failing because there is nothing to do
1885
self.run_bzr_error(['no changes to commit'],
1886
['commit', '-m', 'my commit comment'])
1887
# Make sure --strict is handling an unknown file, rather than
1888
# giving us the 'nothing to do' error
1889
self.build_tree(['unknown'])
1890
self.run_bzr_error(['Commit refused because there are unknown files'],
1891
['commit', --strict', '-m', 'my commit comment'])
1893
kwargs.setdefault('retcode', 3)
1894
kwargs['error_regexes'] = error_regexes
1895
out, err = self.run_bzr(*args, **kwargs)
1898
def run_bzr_subprocess(self, *args, **kwargs):
1899
"""Run bzr in a subprocess for testing.
1901
This starts a new Python interpreter and runs bzr in there.
1902
This should only be used for tests that have a justifiable need for
1903
this isolation: e.g. they are testing startup time, or signal
1904
handling, or early startup code, etc. Subprocess code can't be
1905
profiled or debugged so easily.
1907
:keyword retcode: The status code that is expected. Defaults to 0. If
1908
None is supplied, the status code is not checked.
1909
:keyword env_changes: A dictionary which lists changes to environment
1910
variables. A value of None will unset the env variable.
1911
The values must be strings. The change will only occur in the
1912
child, so you don't need to fix the environment after running.
1913
:keyword universal_newlines: Convert CRLF => LF
1914
:keyword allow_plugins: By default the subprocess is run with
1915
--no-plugins to ensure test reproducibility. Also, it is possible
1916
for system-wide plugins to create unexpected output on stderr,
1917
which can cause unnecessary test failures.
1919
env_changes = kwargs.get('env_changes', {})
1920
working_dir = kwargs.get('working_dir', None)
1921
allow_plugins = kwargs.get('allow_plugins', False)
1923
if isinstance(args[0], list):
1925
elif isinstance(args[0], basestring):
1926
args = list(shlex.split(args[0]))
1928
raise ValueError("passing varargs to run_bzr_subprocess")
1929
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1930
working_dir=working_dir,
1931
allow_plugins=allow_plugins)
1932
# We distinguish between retcode=None and retcode not passed.
1933
supplied_retcode = kwargs.get('retcode', 0)
1934
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1935
universal_newlines=kwargs.get('universal_newlines', False),
1938
def start_bzr_subprocess(self, process_args, env_changes=None,
1939
skip_if_plan_to_signal=False,
1941
allow_plugins=False):
1942
"""Start bzr in a subprocess for testing.
1944
This starts a new Python interpreter and runs bzr in there.
1945
This should only be used for tests that have a justifiable need for
1946
this isolation: e.g. they are testing startup time, or signal
1947
handling, or early startup code, etc. Subprocess code can't be
1948
profiled or debugged so easily.
1950
:param process_args: a list of arguments to pass to the bzr executable,
1951
for example ``['--version']``.
1952
:param env_changes: A dictionary which lists changes to environment
1953
variables. A value of None will unset the env variable.
1954
The values must be strings. The change will only occur in the
1955
child, so you don't need to fix the environment after running.
1956
:param skip_if_plan_to_signal: raise TestSkipped when true and system
1957
doesn't support signalling subprocesses.
1958
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1960
:returns: Popen object for the started process.
1962
if skip_if_plan_to_signal:
1963
if os.name != "posix":
1964
raise TestSkipped("Sending signals not supported")
1966
if env_changes is None:
1970
def cleanup_environment():
1971
for env_var, value in env_changes.iteritems():
1972
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1974
def restore_environment():
1975
for env_var, value in old_env.iteritems():
1976
osutils.set_or_unset_env(env_var, value)
1978
bzr_path = self.get_bzr_path()
1981
if working_dir is not None:
1982
cwd = osutils.getcwd()
1983
os.chdir(working_dir)
1986
# win32 subprocess doesn't support preexec_fn
1987
# so we will avoid using it on all platforms, just to
1988
# make sure the code path is used, and we don't break on win32
1989
cleanup_environment()
1990
command = [sys.executable]
1991
# frozen executables don't need the path to bzr
1992
if getattr(sys, "frozen", None) is None:
1993
command.append(bzr_path)
1994
if not allow_plugins:
1995
command.append('--no-plugins')
1996
command.extend(process_args)
1997
process = self._popen(command, stdin=subprocess.PIPE,
1998
stdout=subprocess.PIPE,
1999
stderr=subprocess.PIPE)
2001
restore_environment()
2007
def _popen(self, *args, **kwargs):
2008
"""Place a call to Popen.
2010
Allows tests to override this method to intercept the calls made to
2011
Popen for introspection.
2013
return subprocess.Popen(*args, **kwargs)
2015
def get_source_path(self):
2016
"""Return the path of the directory containing bzrlib."""
2017
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2019
def get_bzr_path(self):
2020
"""Return the path of the 'bzr' executable for this test suite."""
2021
bzr_path = os.path.join(self.get_source_path(), "bzr")
2022
if not os.path.isfile(bzr_path):
2023
# We are probably installed. Assume sys.argv is the right file
2024
bzr_path = sys.argv[0]
2027
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2028
universal_newlines=False, process_args=None):
2029
"""Finish the execution of process.
2031
:param process: the Popen object returned from start_bzr_subprocess.
2032
:param retcode: The status code that is expected. Defaults to 0. If
2033
None is supplied, the status code is not checked.
2034
:param send_signal: an optional signal to send to the process.
2035
:param universal_newlines: Convert CRLF => LF
2036
:returns: (stdout, stderr)
2038
if send_signal is not None:
2039
os.kill(process.pid, send_signal)
2040
out, err = process.communicate()
2042
if universal_newlines:
2043
out = out.replace('\r\n', '\n')
2044
err = err.replace('\r\n', '\n')
2046
if retcode is not None and retcode != process.returncode:
2047
if process_args is None:
2048
process_args = "(unknown args)"
2049
mutter('Output of bzr %s:\n%s', process_args, out)
2050
mutter('Error for bzr %s:\n%s', process_args, err)
2051
self.fail('Command bzr %s failed with retcode %s != %s'
2052
% (process_args, retcode, process.returncode))
371
2055
def check_inventory_shape(self, inv, shape):
372
2056
"""Compare an inventory to a list of expected names.
434
2490
All test cases create their own directory within that. If the
435
2491
tests complete successfully, the directory is removed.
437
InTempDir is an old alias for FunctionalTestCase.
2493
:ivar test_base_dir: The path of the top-level directory for this
2494
test, which contains a home directory and a work directory.
2496
:ivar test_home_dir: An initially empty directory under test_base_dir
2497
which is used as $HOME for this test.
2499
:ivar test_dir: A directory under test_base_dir used as the current
2500
directory when the test proper is run.
442
2503
OVERRIDE_PYTHON = 'python'
444
2505
def check_file_contents(self, filename, expect):
445
2506
self.log("check contents of file %s" % filename)
446
contents = file(filename, 'r').read()
447
2512
if contents != expect:
448
2513
self.log("expected: %r" % expect)
449
2514
self.log("actually: %r" % contents)
450
2515
self.fail("contents of %s not as expected" % filename)
452
def _make_test_root(self):
453
if TestCaseInTempDir.TEST_ROOT is not None:
457
root = u'test%04d.tmp' % i
461
if e.errno == errno.EEXIST:
466
# successfully created
467
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
469
# make a fake bzr directory there to prevent any tests propagating
470
# up onto the source directory's real branch
471
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
474
super(TestCaseInTempDir, self).setUp()
475
self._make_test_root()
476
_currentdir = os.getcwdu()
477
short_id = self.id().replace('bzrlib.selftest.', '') \
478
.replace('__main__.', '')
479
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
2517
def _getTestDirPrefix(self):
2518
# create a directory within the top level test directory
2519
if sys.platform in ('win32', 'cygwin'):
2520
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2521
# windows is likely to have path-length limits so use a short name
2522
name_prefix = name_prefix[-30:]
2524
name_prefix = re.sub('[/]', '_', self.id())
2527
def makeAndChdirToTestDir(self):
2528
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2530
For TestCaseInTempDir we create a temporary directory based on the test
2531
name and then create two subdirs - test and home under it.
2533
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2534
self._getTestDirPrefix())
2536
for i in range(100):
2537
if os.path.exists(name):
2538
name = name_prefix + '_' + str(i)
2540
# now create test and home directories within this dir
2541
self.test_base_dir = name
2542
self.addCleanup(self.deleteTestDir)
2543
os.mkdir(self.test_base_dir)
2545
self.permit_dir(self.test_base_dir)
2546
# 'sprouting' and 'init' of a branch both walk up the tree to find
2547
# stacking policy to honour; create a bzr dir with an unshared
2548
# repository (but not a branch - our code would be trying to escape
2549
# then!) to stop them, and permit it to be read.
2550
# control = bzrdir.BzrDir.create(self.test_base_dir)
2551
# control.create_repository()
2552
self.test_home_dir = self.test_base_dir + '/home'
2553
os.mkdir(self.test_home_dir)
2554
self.test_dir = self.test_base_dir + '/work'
480
2555
os.mkdir(self.test_dir)
481
2556
os.chdir(self.test_dir)
482
os.environ['HOME'] = self.test_dir
483
def _leaveDirectory():
484
os.chdir(_currentdir)
485
self.addCleanup(_leaveDirectory)
487
def build_tree(self, shape, line_endings='native'):
2557
# put name of test inside
2558
f = file(self.test_base_dir + '/name', 'w')
2564
def deleteTestDir(self):
2565
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2566
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2568
def build_tree(self, shape, line_endings='binary', transport=None):
488
2569
"""Build a test tree according to a pattern.
490
2571
shape is a sequence of file specifications. If the final
491
2572
character is '/', a directory is created.
2574
This assumes that all the elements in the tree being built are new.
493
2576
This doesn't add anything to a branch.
2578
:type shape: list or tuple.
494
2579
:param line_endings: Either 'binary' or 'native'
495
in binary mode, exact contents are written
496
in native mode, the line endings match the
497
default platform endings.
2580
in binary mode, exact contents are written in native mode, the
2581
line endings match the default platform endings.
2582
:param transport: A transport to write to, for building trees on VFS's.
2583
If the transport is readonly or None, "." is opened automatically.
499
# XXX: It's OK to just create them using forward slashes on windows?
2586
if type(shape) not in (list, tuple):
2587
raise AssertionError("Parameter 'shape' should be "
2588
"a list or a tuple. Got %r instead" % (shape,))
2589
# It's OK to just create them using forward slashes on windows.
2590
if transport is None or transport.is_readonly():
2591
transport = _mod_transport.get_transport(".")
500
2592
for name in shape:
501
self.assert_(isinstance(name, basestring))
2593
self.assertIsInstance(name, basestring)
502
2594
if name[-1] == '/':
2595
transport.mkdir(urlutils.escape(name[:-1]))
505
2597
if line_endings == 'binary':
507
2599
elif line_endings == 'native':
510
raise BzrError('Invalid line ending request %r' % (line_endings,))
511
print >>f, "contents of", name
514
def build_tree_contents(self, shape):
515
bzrlib.selftest.build_tree_contents(shape)
517
def failUnlessExists(self, path):
518
"""Fail unless path, which may be abs or relative, exists."""
519
self.failUnless(osutils.lexists(path))
521
def assertFileEqual(self, content, path):
522
"""Fail if path does not contain 'content'."""
523
self.failUnless(osutils.lexists(path))
524
self.assertEqualDiff(content, open(path, 'r').read())
527
class MetaTestLog(TestCase):
528
def test_logging(self):
529
"""Test logs are captured when a test fails."""
530
self.log('a test message')
531
self.assertContainsRe(self._get_log(), 'a test message\n')
2602
raise errors.BzrError(
2603
'Invalid line ending request %r' % line_endings)
2604
content = "contents of %s%s" % (name.encode('utf-8'), end)
2605
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2607
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2609
def assertInWorkingTree(self, path, root_path='.', tree=None):
2610
"""Assert whether path or paths are in the WorkingTree"""
2612
tree = workingtree.WorkingTree.open(root_path)
2613
if not isinstance(path, basestring):
2615
self.assertInWorkingTree(p, tree=tree)
2617
self.assertIsNot(tree.path2id(path), None,
2618
path+' not in working tree.')
2620
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2621
"""Assert whether path or paths are not in the WorkingTree"""
2623
tree = workingtree.WorkingTree.open(root_path)
2624
if not isinstance(path, basestring):
2626
self.assertNotInWorkingTree(p,tree=tree)
2628
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2631
class TestCaseWithTransport(TestCaseInTempDir):
2632
"""A test case that provides get_url and get_readonly_url facilities.
2634
These back onto two transport servers, one for readonly access and one for
2637
If no explicit class is provided for readonly access, a
2638
ReadonlyTransportDecorator is used instead which allows the use of non disk
2639
based read write transports.
2641
If an explicit class is provided for readonly access, that server and the
2642
readwrite one must both define get_url() as resolving to os.getcwd().
2645
def get_vfs_only_server(self):
2646
"""See TestCaseWithMemoryTransport.
2648
This is useful for some tests with specific servers that need
2651
if self.__vfs_server is None:
2652
self.__vfs_server = self.vfs_transport_factory()
2653
self.start_server(self.__vfs_server)
2654
return self.__vfs_server
2656
def make_branch_and_tree(self, relpath, format=None):
2657
"""Create a branch on the transport and a tree locally.
2659
If the transport is not a LocalTransport, the Tree can't be created on
2660
the transport. In that case if the vfs_transport_factory is
2661
LocalURLServer the working tree is created in the local
2662
directory backing the transport, and the returned tree's branch and
2663
repository will also be accessed locally. Otherwise a lightweight
2664
checkout is created and returned.
2666
We do this because we can't physically create a tree in the local
2667
path, with a branch reference to the transport_factory url, and
2668
a branch + repository in the vfs_transport, unless the vfs_transport
2669
namespace is distinct from the local disk - the two branch objects
2670
would collide. While we could construct a tree with its branch object
2671
pointing at the transport_factory transport in memory, reopening it
2672
would behaving unexpectedly, and has in the past caused testing bugs
2673
when we tried to do it that way.
2675
:param format: The BzrDirFormat.
2676
:returns: the WorkingTree.
2678
# TODO: always use the local disk path for the working tree,
2679
# this obviously requires a format that supports branch references
2680
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2682
b = self.make_branch(relpath, format=format)
2684
return b.bzrdir.create_workingtree()
2685
except errors.NotLocalUrl:
2686
# We can only make working trees locally at the moment. If the
2687
# transport can't support them, then we keep the non-disk-backed
2688
# branch and create a local checkout.
2689
if self.vfs_transport_factory is test_server.LocalURLServer:
2690
# the branch is colocated on disk, we cannot create a checkout.
2691
# hopefully callers will expect this.
2692
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2693
wt = local_controldir.create_workingtree()
2694
if wt.branch._format != b._format:
2696
# Make sure that assigning to wt._branch fixes wt.branch,
2697
# in case the implementation details of workingtree objects
2699
self.assertIs(b, wt.branch)
2702
return b.create_checkout(relpath, lightweight=True)
2704
def assertIsDirectory(self, relpath, transport):
2705
"""Assert that relpath within transport is a directory.
2707
This may not be possible on all transports; in that case it propagates
2708
a TransportNotPossible.
2711
mode = transport.stat(relpath).st_mode
2712
except errors.NoSuchFile:
2713
self.fail("path %s is not a directory; no such file"
2715
if not stat.S_ISDIR(mode):
2716
self.fail("path %s is not a directory; has mode %#o"
2719
def assertTreesEqual(self, left, right):
2720
"""Check that left and right have the same content and properties."""
2721
# we use a tree delta to check for equality of the content, and we
2722
# manually check for equality of other things such as the parents list.
2723
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2724
differences = left.changes_from(right)
2725
self.assertFalse(differences.has_changed(),
2726
"Trees %r and %r are different: %r" % (left, right, differences))
2729
super(TestCaseWithTransport, self).setUp()
2730
self.__vfs_server = None
2732
def disable_missing_extensions_warning(self):
2733
"""Some tests expect a precise stderr content.
2735
There is no point in forcing them to duplicate the extension related
2738
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2741
class ChrootedTestCase(TestCaseWithTransport):
2742
"""A support class that provides readonly urls outside the local namespace.
2744
This is done by checking if self.transport_server is a MemoryServer. if it
2745
is then we are chrooted already, if it is not then an HttpServer is used
2748
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2749
be used without needed to redo it when a different
2750
subclass is in use ?
2754
from bzrlib.tests import http_server
2755
super(ChrootedTestCase, self).setUp()
2756
if not self.vfs_transport_factory == memory.MemoryServer:
2757
self.transport_readonly_server = http_server.HttpServer
2760
def condition_id_re(pattern):
2761
"""Create a condition filter which performs a re check on a test's id.
2763
:param pattern: A regular expression string.
2764
:return: A callable that returns True if the re matches.
2766
filter_re = re.compile(pattern, 0)
2767
def condition(test):
2769
return filter_re.search(test_id)
2773
def condition_isinstance(klass_or_klass_list):
2774
"""Create a condition filter which returns isinstance(param, klass).
2776
:return: A callable which when called with one parameter obj return the
2777
result of isinstance(obj, klass_or_klass_list).
2780
return isinstance(obj, klass_or_klass_list)
2784
def condition_id_in_list(id_list):
2785
"""Create a condition filter which verify that test's id in a list.
2787
:param id_list: A TestIdList object.
2788
:return: A callable that returns True if the test's id appears in the list.
2790
def condition(test):
2791
return id_list.includes(test.id())
2795
def condition_id_startswith(starts):
2796
"""Create a condition filter verifying that test's id starts with a string.
2798
:param starts: A list of string.
2799
:return: A callable that returns True if the test's id starts with one of
2802
def condition(test):
2803
for start in starts:
2804
if test.id().startswith(start):
2810
def exclude_tests_by_condition(suite, condition):
2811
"""Create a test suite which excludes some tests from suite.
2813
:param suite: The suite to get tests from.
2814
:param condition: A callable whose result evaluates True when called with a
2815
test case which should be excluded from the result.
2816
:return: A suite which contains the tests found in suite that fail
2820
for test in iter_suite_tests(suite):
2821
if not condition(test):
2823
return TestUtil.TestSuite(result)
2826
def filter_suite_by_condition(suite, condition):
2827
"""Create a test suite by filtering another one.
2829
:param suite: The source suite.
2830
:param condition: A callable whose result evaluates True when called with a
2831
test case which should be included in the result.
2832
:return: A suite which contains the tests found in suite that pass
2836
for test in iter_suite_tests(suite):
2839
return TestUtil.TestSuite(result)
534
2842
def filter_suite_by_re(suite, pattern):
535
result = TestUtil.TestSuite()
536
filter_re = re.compile(pattern)
2843
"""Create a test suite by filtering another one.
2845
:param suite: the source suite
2846
:param pattern: pattern that names must match
2847
:returns: the newly created suite
2849
condition = condition_id_re(pattern)
2850
result_suite = filter_suite_by_condition(suite, condition)
2854
def filter_suite_by_id_list(suite, test_id_list):
2855
"""Create a test suite by filtering another one.
2857
:param suite: The source suite.
2858
:param test_id_list: A list of the test ids to keep as strings.
2859
:returns: the newly created suite
2861
condition = condition_id_in_list(test_id_list)
2862
result_suite = filter_suite_by_condition(suite, condition)
2866
def filter_suite_by_id_startswith(suite, start):
2867
"""Create a test suite by filtering another one.
2869
:param suite: The source suite.
2870
:param start: A list of string the test id must start with one of.
2871
:returns: the newly created suite
2873
condition = condition_id_startswith(start)
2874
result_suite = filter_suite_by_condition(suite, condition)
2878
def exclude_tests_by_re(suite, pattern):
2879
"""Create a test suite which excludes some tests from suite.
2881
:param suite: The suite to get tests from.
2882
:param pattern: A regular expression string. Test ids that match this
2883
pattern will be excluded from the result.
2884
:return: A TestSuite that contains all the tests from suite without the
2885
tests that matched pattern. The order of tests is the same as it was in
2888
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2891
def preserve_input(something):
2892
"""A helper for performing test suite transformation chains.
2894
:param something: Anything you want to preserve.
2900
def randomize_suite(suite):
2901
"""Return a new TestSuite with suite's tests in random order.
2903
The tests in the input suite are flattened into a single suite in order to
2904
accomplish this. Any nested TestSuites are removed to provide global
2907
tests = list(iter_suite_tests(suite))
2908
random.shuffle(tests)
2909
return TestUtil.TestSuite(tests)
2912
def split_suite_by_condition(suite, condition):
2913
"""Split a test suite into two by a condition.
2915
:param suite: The suite to split.
2916
:param condition: The condition to match on. Tests that match this
2917
condition are returned in the first test suite, ones that do not match
2918
are in the second suite.
2919
:return: A tuple of two test suites, where the first contains tests from
2920
suite matching the condition, and the second contains the remainder
2921
from suite. The order within each output suite is the same as it was in
537
2926
for test in iter_suite_tests(suite):
538
if filter_re.search(test.id()):
2928
matched.append(test)
2930
did_not_match.append(test)
2931
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2934
def split_suite_by_re(suite, pattern):
2935
"""Split a test suite into two by a regular expression.
2937
:param suite: The suite to split.
2938
:param pattern: A regular expression string. Test ids that match this
2939
pattern will be in the first test suite returned, and the others in the
2940
second test suite returned.
2941
:return: A tuple of two test suites, where the first contains tests from
2942
suite matching pattern, and the second contains the remainder from
2943
suite. The order within each output suite is the same as it was in
2946
return split_suite_by_condition(suite, condition_id_re(pattern))
543
2949
def run_suite(suite, name='test', verbose=False, pattern=".*",
544
stop_on_failure=False, keep_output=False):
545
TestCaseInTempDir._TEST_NAME = name
2950
stop_on_failure=False,
2951
transport=None, lsprof_timed=None, bench_history=None,
2952
matching_tests_first=None,
2955
exclude_pattern=None,
2958
suite_decorators=None,
2960
result_decorators=None,
2962
"""Run a test suite for bzr selftest.
2964
:param runner_class: The class of runner to use. Must support the
2965
constructor arguments passed by run_suite which are more than standard
2967
:return: A boolean indicating success.
2969
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
550
runner = TextTestRunner(stream=sys.stdout,
2974
if runner_class is None:
2975
runner_class = TextTestRunner
2978
runner = runner_class(stream=stream,
2980
verbosity=verbosity,
2981
bench_history=bench_history,
2983
result_decorators=result_decorators,
553
2985
runner.stop_on_failure=stop_on_failure
555
suite = filter_suite_by_re(suite, pattern)
2986
# built in decorator factories:
2988
random_order(random_seed, runner),
2989
exclude_tests(exclude_pattern),
2991
if matching_tests_first:
2992
decorators.append(tests_first(pattern))
2994
decorators.append(filter_tests(pattern))
2995
if suite_decorators:
2996
decorators.extend(suite_decorators)
2997
# tell the result object how many tests will be running: (except if
2998
# --parallel=fork is being used. Robert said he will provide a better
2999
# progress design later -- vila 20090817)
3000
if fork_decorator not in decorators:
3001
decorators.append(CountingDecorator)
3002
for decorator in decorators:
3003
suite = decorator(suite)
3005
# Done after test suite decoration to allow randomisation etc
3006
# to take effect, though that is of marginal benefit.
3008
stream.write("Listing tests only ...\n")
3009
for t in iter_suite_tests(suite):
3010
stream.write("%s\n" % (t.id()))
556
3012
result = runner.run(suite)
557
# This is still a little bogus,
558
# but only a little. Folk not using our testrunner will
559
# have to delete their temp directories themselves.
560
if result.wasSuccessful() or not keep_output:
561
if TestCaseInTempDir.TEST_ROOT is not None:
562
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
3014
return result.wasStrictlySuccessful()
564
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
565
return result.wasSuccessful()
3016
return result.wasSuccessful()
3019
# A registry where get() returns a suite decorator.
3020
parallel_registry = registry.Registry()
3023
def fork_decorator(suite):
3024
if getattr(os, "fork", None) is None:
3025
raise errors.BzrCommandError("platform does not support fork,"
3026
" try --parallel=subprocess instead.")
3027
concurrency = osutils.local_concurrency()
3028
if concurrency == 1:
3030
from testtools import ConcurrentTestSuite
3031
return ConcurrentTestSuite(suite, fork_for_tests)
3032
parallel_registry.register('fork', fork_decorator)
3035
def subprocess_decorator(suite):
3036
concurrency = osutils.local_concurrency()
3037
if concurrency == 1:
3039
from testtools import ConcurrentTestSuite
3040
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3041
parallel_registry.register('subprocess', subprocess_decorator)
3044
def exclude_tests(exclude_pattern):
3045
"""Return a test suite decorator that excludes tests."""
3046
if exclude_pattern is None:
3047
return identity_decorator
3048
def decorator(suite):
3049
return ExcludeDecorator(suite, exclude_pattern)
3053
def filter_tests(pattern):
3055
return identity_decorator
3056
def decorator(suite):
3057
return FilterTestsDecorator(suite, pattern)
3061
def random_order(random_seed, runner):
3062
"""Return a test suite decorator factory for randomising tests order.
3064
:param random_seed: now, a string which casts to a long, or a long.
3065
:param runner: A test runner with a stream attribute to report on.
3067
if random_seed is None:
3068
return identity_decorator
3069
def decorator(suite):
3070
return RandomDecorator(suite, random_seed, runner.stream)
3074
def tests_first(pattern):
3076
return identity_decorator
3077
def decorator(suite):
3078
return TestFirstDecorator(suite, pattern)
3082
def identity_decorator(suite):
3087
class TestDecorator(TestUtil.TestSuite):
3088
"""A decorator for TestCase/TestSuite objects.
3090
Usually, subclasses should override __iter__(used when flattening test
3091
suites), which we do to filter, reorder, parallelise and so on, run() and
3095
def __init__(self, suite):
3096
TestUtil.TestSuite.__init__(self)
3099
def countTestCases(self):
3102
cases += test.countTestCases()
3109
def run(self, result):
3110
# Use iteration on self, not self._tests, to allow subclasses to hook
3113
if result.shouldStop:
3119
class CountingDecorator(TestDecorator):
3120
"""A decorator which calls result.progress(self.countTestCases)."""
3122
def run(self, result):
3123
progress_method = getattr(result, 'progress', None)
3124
if callable(progress_method):
3125
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3126
return super(CountingDecorator, self).run(result)
3129
class ExcludeDecorator(TestDecorator):
3130
"""A decorator which excludes test matching an exclude pattern."""
3132
def __init__(self, suite, exclude_pattern):
3133
TestDecorator.__init__(self, suite)
3134
self.exclude_pattern = exclude_pattern
3135
self.excluded = False
3139
return iter(self._tests)
3140
self.excluded = True
3141
suite = exclude_tests_by_re(self, self.exclude_pattern)
3143
self.addTests(suite)
3144
return iter(self._tests)
3147
class FilterTestsDecorator(TestDecorator):
3148
"""A decorator which filters tests to those matching a pattern."""
3150
def __init__(self, suite, pattern):
3151
TestDecorator.__init__(self, suite)
3152
self.pattern = pattern
3153
self.filtered = False
3157
return iter(self._tests)
3158
self.filtered = True
3159
suite = filter_suite_by_re(self, self.pattern)
3161
self.addTests(suite)
3162
return iter(self._tests)
3165
class RandomDecorator(TestDecorator):
3166
"""A decorator which randomises the order of its tests."""
3168
def __init__(self, suite, random_seed, stream):
3169
TestDecorator.__init__(self, suite)
3170
self.random_seed = random_seed
3171
self.randomised = False
3172
self.stream = stream
3176
return iter(self._tests)
3177
self.randomised = True
3178
self.stream.write("Randomizing test order using seed %s\n\n" %
3179
(self.actual_seed()))
3180
# Initialise the random number generator.
3181
random.seed(self.actual_seed())
3182
suite = randomize_suite(self)
3184
self.addTests(suite)
3185
return iter(self._tests)
3187
def actual_seed(self):
3188
if self.random_seed == "now":
3189
# We convert the seed to a long to make it reuseable across
3190
# invocations (because the user can reenter it).
3191
self.random_seed = long(time.time())
3193
# Convert the seed to a long if we can
3195
self.random_seed = long(self.random_seed)
3198
return self.random_seed
3201
class TestFirstDecorator(TestDecorator):
3202
"""A decorator which moves named tests to the front."""
3204
def __init__(self, suite, pattern):
3205
TestDecorator.__init__(self, suite)
3206
self.pattern = pattern
3207
self.filtered = False
3211
return iter(self._tests)
3212
self.filtered = True
3213
suites = split_suite_by_re(self, self.pattern)
3215
self.addTests(suites)
3216
return iter(self._tests)
3219
def partition_tests(suite, count):
3220
"""Partition suite into count lists of tests."""
3221
# This just assigns tests in a round-robin fashion. On one hand this
3222
# splits up blocks of related tests that might run faster if they shared
3223
# resources, but on the other it avoids assigning blocks of slow tests to
3224
# just one partition. So the slowest partition shouldn't be much slower
3226
partitions = [list() for i in range(count)]
3227
tests = iter_suite_tests(suite)
3228
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3229
partition.append(test)
3233
def workaround_zealous_crypto_random():
3234
"""Crypto.Random want to help us being secure, but we don't care here.
3236
This workaround some test failure related to the sftp server. Once paramiko
3237
stop using the controversial API in Crypto.Random, we may get rid of it.
3240
from Crypto.Random import atfork
3246
def fork_for_tests(suite):
3247
"""Take suite and start up one runner per CPU by forking()
3249
:return: An iterable of TestCase-like objects which can each have
3250
run(result) called on them to feed tests to result.
3252
concurrency = osutils.local_concurrency()
3254
from subunit import TestProtocolClient, ProtocolTestCase
3255
from subunit.test_results import AutoTimingTestResultDecorator
3256
class TestInOtherProcess(ProtocolTestCase):
3257
# Should be in subunit, I think. RBC.
3258
def __init__(self, stream, pid):
3259
ProtocolTestCase.__init__(self, stream)
3262
def run(self, result):
3264
ProtocolTestCase.run(self, result)
3266
os.waitpid(self.pid, 0)
3268
test_blocks = partition_tests(suite, concurrency)
3269
for process_tests in test_blocks:
3270
process_suite = TestUtil.TestSuite()
3271
process_suite.addTests(process_tests)
3272
c2pread, c2pwrite = os.pipe()
3275
workaround_zealous_crypto_random()
3278
# Leave stderr and stdout open so we can see test noise
3279
# Close stdin so that the child goes away if it decides to
3280
# read from stdin (otherwise its a roulette to see what
3281
# child actually gets keystrokes for pdb etc).
3284
stream = os.fdopen(c2pwrite, 'wb', 1)
3285
subunit_result = AutoTimingTestResultDecorator(
3286
TestProtocolClient(stream))
3287
process_suite.run(subunit_result)
3292
stream = os.fdopen(c2pread, 'rb', 1)
3293
test = TestInOtherProcess(stream, pid)
3298
def reinvoke_for_tests(suite):
3299
"""Take suite and start up one runner per CPU using subprocess().
3301
:return: An iterable of TestCase-like objects which can each have
3302
run(result) called on them to feed tests to result.
3304
concurrency = osutils.local_concurrency()
3306
from subunit import ProtocolTestCase
3307
class TestInSubprocess(ProtocolTestCase):
3308
def __init__(self, process, name):
3309
ProtocolTestCase.__init__(self, process.stdout)
3310
self.process = process
3311
self.process.stdin.close()
3314
def run(self, result):
3316
ProtocolTestCase.run(self, result)
3319
os.unlink(self.name)
3320
# print "pid %d finished" % finished_process
3321
test_blocks = partition_tests(suite, concurrency)
3322
for process_tests in test_blocks:
3323
# ugly; currently reimplement rather than reuses TestCase methods.
3324
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3325
if not os.path.isfile(bzr_path):
3326
# We are probably installed. Assume sys.argv is the right file
3327
bzr_path = sys.argv[0]
3328
bzr_path = [bzr_path]
3329
if sys.platform == "win32":
3330
# if we're on windows, we can't execute the bzr script directly
3331
bzr_path = [sys.executable] + bzr_path
3332
fd, test_list_file_name = tempfile.mkstemp()
3333
test_list_file = os.fdopen(fd, 'wb', 1)
3334
for test in process_tests:
3335
test_list_file.write(test.id() + '\n')
3336
test_list_file.close()
3338
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3340
if '--no-plugins' in sys.argv:
3341
argv.append('--no-plugins')
3342
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3343
# noise on stderr it can interrupt the subunit protocol.
3344
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3345
stdout=subprocess.PIPE,
3346
stderr=subprocess.PIPE,
3348
test = TestInSubprocess(process, test_list_file_name)
3351
os.unlink(test_list_file_name)
3356
class ForwardingResult(unittest.TestResult):
3358
def __init__(self, target):
3359
unittest.TestResult.__init__(self)
3360
self.result = target
3362
def startTest(self, test):
3363
self.result.startTest(test)
3365
def stopTest(self, test):
3366
self.result.stopTest(test)
3368
def startTestRun(self):
3369
self.result.startTestRun()
3371
def stopTestRun(self):
3372
self.result.stopTestRun()
3374
def addSkip(self, test, reason):
3375
self.result.addSkip(test, reason)
3377
def addSuccess(self, test):
3378
self.result.addSuccess(test)
3380
def addError(self, test, err):
3381
self.result.addError(test, err)
3383
def addFailure(self, test, err):
3384
self.result.addFailure(test, err)
3385
ForwardingResult = testtools.ExtendedToOriginalDecorator
3388
class ProfileResult(ForwardingResult):
3389
"""Generate profiling data for all activity between start and success.
3391
The profile data is appended to the test's _benchcalls attribute and can
3392
be accessed by the forwarded-to TestResult.
3394
While it might be cleaner do accumulate this in stopTest, addSuccess is
3395
where our existing output support for lsprof is, and this class aims to
3396
fit in with that: while it could be moved it's not necessary to accomplish
3397
test profiling, nor would it be dramatically cleaner.
3400
def startTest(self, test):
3401
self.profiler = bzrlib.lsprof.BzrProfiler()
3402
# Prevent deadlocks in tests that use lsprof: those tests will
3404
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3405
self.profiler.start()
3406
ForwardingResult.startTest(self, test)
3408
def addSuccess(self, test):
3409
stats = self.profiler.stop()
3411
calls = test._benchcalls
3412
except AttributeError:
3413
test._benchcalls = []
3414
calls = test._benchcalls
3415
calls.append(((test.id(), "", ""), stats))
3416
ForwardingResult.addSuccess(self, test)
3418
def stopTest(self, test):
3419
ForwardingResult.stopTest(self, test)
3420
self.profiler = None
3423
# Controlled by "bzr selftest -E=..." option
3424
# Currently supported:
3425
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3426
# preserves any flags supplied at the command line.
3427
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3428
# rather than failing tests. And no longer raise
3429
# LockContention when fctnl locks are not being used
3430
# with proper exclusion rules.
3431
# -Ethreads Will display thread ident at creation/join time to
3432
# help track thread leaks
3433
selftest_debug_flags = set()
568
3436
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3438
test_suite_factory=None,
3441
matching_tests_first=None,
3444
exclude_pattern=None,
3450
suite_decorators=None,
570
3454
"""Run the whole test suite under the enhanced runner"""
571
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
572
stop_on_failure=stop_on_failure, keep_output=keep_output)
576
"""Build and return TestSuite for the whole program."""
577
import bzrlib.store, bzrlib.inventory, bzrlib.branch
578
import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
579
from doctest import DocTestSuite
581
global MODULES_TO_TEST, MODULES_TO_DOCTEST
583
# FIXME: If these fail to load, e.g. because of a syntax error, the
584
# exception is hidden by unittest. Sucks. Should either fix that or
585
# perhaps import them and pass them to unittest as modules.
587
['bzrlib.selftest.MetaTestLog',
588
'bzrlib.selftest.testapi',
589
'bzrlib.selftest.testgpg',
590
'bzrlib.selftest.testidentitymap',
591
'bzrlib.selftest.testinv',
592
'bzrlib.selftest.test_ancestry',
593
'bzrlib.selftest.test_commit',
594
'bzrlib.selftest.test_command',
595
'bzrlib.selftest.test_commit_merge',
596
'bzrlib.selftest.testconfig',
597
'bzrlib.selftest.versioning',
598
'bzrlib.selftest.testmerge3',
599
'bzrlib.selftest.testmerge',
600
'bzrlib.selftest.testhashcache',
601
'bzrlib.selftest.teststatus',
602
'bzrlib.selftest.testlog',
603
'bzrlib.selftest.testrevisionnamespaces',
604
'bzrlib.selftest.testbranch',
605
'bzrlib.selftest.testrevision',
606
'bzrlib.selftest.test_revision_info',
607
'bzrlib.selftest.test_merge_core',
608
'bzrlib.selftest.test_smart_add',
609
'bzrlib.selftest.test_bad_files',
610
'bzrlib.selftest.testdiff',
611
'bzrlib.selftest.test_parent',
612
'bzrlib.selftest.test_xml',
613
'bzrlib.selftest.test_weave',
614
'bzrlib.selftest.testfetch',
615
'bzrlib.selftest.whitebox',
616
'bzrlib.selftest.teststore',
617
'bzrlib.selftest.blackbox',
618
'bzrlib.selftest.testsampler',
619
'bzrlib.selftest.testtransactions',
620
'bzrlib.selftest.testtransport',
621
'bzrlib.selftest.testsftp',
622
'bzrlib.selftest.testgraph',
623
'bzrlib.selftest.testworkingtree',
624
'bzrlib.selftest.test_upgrade',
625
'bzrlib.selftest.test_conflicts',
626
'bzrlib.selftest.testtestament',
627
'bzrlib.selftest.testannotate',
628
'bzrlib.selftest.testrevprops',
629
'bzrlib.selftest.testoptions',
630
'bzrlib.selftest.testhttp',
631
'bzrlib.selftest.testnonascii',
632
'bzrlib.selftest.testreweave',
633
'bzrlib.selftest.testtsort',
634
'bzrlib.selftest.testtrace',
637
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
638
bzrlib.osutils, bzrlib.commands, bzrlib.merge3,
641
if m not in MODULES_TO_DOCTEST:
642
MODULES_TO_DOCTEST.append(m)
644
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
645
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
648
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
649
for m in MODULES_TO_TEST:
650
suite.addTest(TestLoader().loadTestsFromModule(m))
651
for m in (MODULES_TO_DOCTEST):
652
suite.addTest(DocTestSuite(m))
653
for p in bzrlib.plugin.all_plugins:
654
if hasattr(p, 'test_suite'):
655
suite.addTest(p.test_suite())
3455
# XXX: Very ugly way to do this...
3456
# Disable warning about old formats because we don't want it to disturb
3457
# any blackbox tests.
3458
from bzrlib import repository
3459
repository._deprecation_warning_done = True
3461
global default_transport
3462
if transport is None:
3463
transport = default_transport
3464
old_transport = default_transport
3465
default_transport = transport
3466
global selftest_debug_flags
3467
old_debug_flags = selftest_debug_flags
3468
if debug_flags is not None:
3469
selftest_debug_flags = set(debug_flags)
3471
if load_list is None:
3474
keep_only = load_test_id_list(load_list)
3476
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3477
for start in starting_with]
3478
if test_suite_factory is None:
3479
# Reduce loading time by loading modules based on the starting_with
3481
suite = test_suite(keep_only, starting_with)
3483
suite = test_suite_factory()
3485
# But always filter as requested.
3486
suite = filter_suite_by_id_startswith(suite, starting_with)
3487
result_decorators = []
3489
result_decorators.append(ProfileResult)
3490
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3491
stop_on_failure=stop_on_failure,
3492
transport=transport,
3493
lsprof_timed=lsprof_timed,
3494
bench_history=bench_history,
3495
matching_tests_first=matching_tests_first,
3496
list_only=list_only,
3497
random_seed=random_seed,
3498
exclude_pattern=exclude_pattern,
3500
runner_class=runner_class,
3501
suite_decorators=suite_decorators,
3503
result_decorators=result_decorators,
3506
default_transport = old_transport
3507
selftest_debug_flags = old_debug_flags
3510
def load_test_id_list(file_name):
3511
"""Load a test id list from a text file.
3513
The format is one test id by line. No special care is taken to impose
3514
strict rules, these test ids are used to filter the test suite so a test id
3515
that do not match an existing test will do no harm. This allows user to add
3516
comments, leave blank lines, etc.
3520
ftest = open(file_name, 'rt')
3522
if e.errno != errno.ENOENT:
3525
raise errors.NoSuchFile(file_name)
3527
for test_name in ftest.readlines():
3528
test_list.append(test_name.strip())
3533
def suite_matches_id_list(test_suite, id_list):
3534
"""Warns about tests not appearing or appearing more than once.
3536
:param test_suite: A TestSuite object.
3537
:param test_id_list: The list of test ids that should be found in
3540
:return: (absents, duplicates) absents is a list containing the test found
3541
in id_list but not in test_suite, duplicates is a list containing the
3542
test found multiple times in test_suite.
3544
When using a prefined test id list, it may occurs that some tests do not
3545
exist anymore or that some tests use the same id. This function warns the
3546
tester about potential problems in his workflow (test lists are volatile)
3547
or in the test suite itself (using the same id for several tests does not
3548
help to localize defects).
3550
# Build a dict counting id occurrences
3552
for test in iter_suite_tests(test_suite):
3554
tests[id] = tests.get(id, 0) + 1
3559
occurs = tests.get(id, 0)
3561
not_found.append(id)
3563
duplicates.append(id)
3565
return not_found, duplicates
3568
class TestIdList(object):
3569
"""Test id list to filter a test suite.
3571
Relying on the assumption that test ids are built as:
3572
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3573
notation, this class offers methods to :
3574
- avoid building a test suite for modules not refered to in the test list,
3575
- keep only the tests listed from the module test suite.
3578
def __init__(self, test_id_list):
3579
# When a test suite needs to be filtered against us we compare test ids
3580
# for equality, so a simple dict offers a quick and simple solution.
3581
self.tests = dict().fromkeys(test_id_list, True)
3583
# While unittest.TestCase have ids like:
3584
# <module>.<class>.<method>[(<param+)],
3585
# doctest.DocTestCase can have ids like:
3588
# <module>.<function>
3589
# <module>.<class>.<method>
3591
# Since we can't predict a test class from its name only, we settle on
3592
# a simple constraint: a test id always begins with its module name.
3595
for test_id in test_id_list:
3596
parts = test_id.split('.')
3597
mod_name = parts.pop(0)
3598
modules[mod_name] = True
3600
mod_name += '.' + part
3601
modules[mod_name] = True
3602
self.modules = modules
3604
def refers_to(self, module_name):
3605
"""Is there tests for the module or one of its sub modules."""
3606
return self.modules.has_key(module_name)
3608
def includes(self, test_id):
3609
return self.tests.has_key(test_id)
3612
class TestPrefixAliasRegistry(registry.Registry):
3613
"""A registry for test prefix aliases.
3615
This helps implement shorcuts for the --starting-with selftest
3616
option. Overriding existing prefixes is not allowed but not fatal (a
3617
warning will be emitted).
3620
def register(self, key, obj, help=None, info=None,
3621
override_existing=False):
3622
"""See Registry.register.
3624
Trying to override an existing alias causes a warning to be emitted,
3625
not a fatal execption.
3628
super(TestPrefixAliasRegistry, self).register(
3629
key, obj, help=help, info=info, override_existing=False)
3631
actual = self.get(key)
3632
note('Test prefix alias %s is already used for %s, ignoring %s'
3633
% (key, actual, obj))
3635
def resolve_alias(self, id_start):
3636
"""Replace the alias by the prefix in the given string.
3638
Using an unknown prefix is an error to help catching typos.
3640
parts = id_start.split('.')
3642
parts[0] = self.get(parts[0])
3644
raise errors.BzrCommandError(
3645
'%s is not a known test prefix alias' % parts[0])
3646
return '.'.join(parts)
3649
test_prefix_alias_registry = TestPrefixAliasRegistry()
3650
"""Registry of test prefix aliases."""
3653
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3654
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3655
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3657
# Obvious highest levels prefixes, feel free to add your own via a plugin
3658
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3659
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3660
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3661
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3662
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3665
def _test_suite_testmod_names():
3666
"""Return the standard list of test module names to test."""
3669
'bzrlib.tests.blackbox',
3670
'bzrlib.tests.commands',
3671
'bzrlib.tests.doc_generate',
3672
'bzrlib.tests.per_branch',
3673
'bzrlib.tests.per_bzrdir',
3674
'bzrlib.tests.per_controldir',
3675
'bzrlib.tests.per_controldir_colo',
3676
'bzrlib.tests.per_foreign_vcs',
3677
'bzrlib.tests.per_interrepository',
3678
'bzrlib.tests.per_intertree',
3679
'bzrlib.tests.per_inventory',
3680
'bzrlib.tests.per_interbranch',
3681
'bzrlib.tests.per_lock',
3682
'bzrlib.tests.per_merger',
3683
'bzrlib.tests.per_transport',
3684
'bzrlib.tests.per_tree',
3685
'bzrlib.tests.per_pack_repository',
3686
'bzrlib.tests.per_repository',
3687
'bzrlib.tests.per_repository_chk',
3688
'bzrlib.tests.per_repository_reference',
3689
'bzrlib.tests.per_uifactory',
3690
'bzrlib.tests.per_versionedfile',
3691
'bzrlib.tests.per_workingtree',
3692
'bzrlib.tests.test__annotator',
3693
'bzrlib.tests.test__bencode',
3694
'bzrlib.tests.test__btree_serializer',
3695
'bzrlib.tests.test__chk_map',
3696
'bzrlib.tests.test__dirstate_helpers',
3697
'bzrlib.tests.test__groupcompress',
3698
'bzrlib.tests.test__known_graph',
3699
'bzrlib.tests.test__rio',
3700
'bzrlib.tests.test__simple_set',
3701
'bzrlib.tests.test__static_tuple',
3702
'bzrlib.tests.test__walkdirs_win32',
3703
'bzrlib.tests.test_ancestry',
3704
'bzrlib.tests.test_annotate',
3705
'bzrlib.tests.test_api',
3706
'bzrlib.tests.test_atomicfile',
3707
'bzrlib.tests.test_bad_files',
3708
'bzrlib.tests.test_bisect_multi',
3709
'bzrlib.tests.test_branch',
3710
'bzrlib.tests.test_branchbuilder',
3711
'bzrlib.tests.test_btree_index',
3712
'bzrlib.tests.test_bugtracker',
3713
'bzrlib.tests.test_bundle',
3714
'bzrlib.tests.test_bzrdir',
3715
'bzrlib.tests.test__chunks_to_lines',
3716
'bzrlib.tests.test_cache_utf8',
3717
'bzrlib.tests.test_chk_map',
3718
'bzrlib.tests.test_chk_serializer',
3719
'bzrlib.tests.test_chunk_writer',
3720
'bzrlib.tests.test_clean_tree',
3721
'bzrlib.tests.test_cleanup',
3722
'bzrlib.tests.test_cmdline',
3723
'bzrlib.tests.test_commands',
3724
'bzrlib.tests.test_commit',
3725
'bzrlib.tests.test_commit_merge',
3726
'bzrlib.tests.test_config',
3727
'bzrlib.tests.test_conflicts',
3728
'bzrlib.tests.test_counted_lock',
3729
'bzrlib.tests.test_crash',
3730
'bzrlib.tests.test_decorators',
3731
'bzrlib.tests.test_delta',
3732
'bzrlib.tests.test_debug',
3733
'bzrlib.tests.test_deprecated_graph',
3734
'bzrlib.tests.test_diff',
3735
'bzrlib.tests.test_directory_service',
3736
'bzrlib.tests.test_dirstate',
3737
'bzrlib.tests.test_email_message',
3738
'bzrlib.tests.test_eol_filters',
3739
'bzrlib.tests.test_errors',
3740
'bzrlib.tests.test_export',
3741
'bzrlib.tests.test_extract',
3742
'bzrlib.tests.test_fetch',
3743
'bzrlib.tests.test_fixtures',
3744
'bzrlib.tests.test_fifo_cache',
3745
'bzrlib.tests.test_filters',
3746
'bzrlib.tests.test_ftp_transport',
3747
'bzrlib.tests.test_foreign',
3748
'bzrlib.tests.test_generate_docs',
3749
'bzrlib.tests.test_generate_ids',
3750
'bzrlib.tests.test_globbing',
3751
'bzrlib.tests.test_gpg',
3752
'bzrlib.tests.test_graph',
3753
'bzrlib.tests.test_groupcompress',
3754
'bzrlib.tests.test_hashcache',
3755
'bzrlib.tests.test_help',
3756
'bzrlib.tests.test_hooks',
3757
'bzrlib.tests.test_http',
3758
'bzrlib.tests.test_http_response',
3759
'bzrlib.tests.test_https_ca_bundle',
3760
'bzrlib.tests.test_identitymap',
3761
'bzrlib.tests.test_ignores',
3762
'bzrlib.tests.test_index',
3763
'bzrlib.tests.test_import_tariff',
3764
'bzrlib.tests.test_info',
3765
'bzrlib.tests.test_inv',
3766
'bzrlib.tests.test_inventory_delta',
3767
'bzrlib.tests.test_knit',
3768
'bzrlib.tests.test_lazy_import',
3769
'bzrlib.tests.test_lazy_regex',
3770
'bzrlib.tests.test_library_state',
3771
'bzrlib.tests.test_lock',
3772
'bzrlib.tests.test_lockable_files',
3773
'bzrlib.tests.test_lockdir',
3774
'bzrlib.tests.test_log',
3775
'bzrlib.tests.test_lru_cache',
3776
'bzrlib.tests.test_lsprof',
3777
'bzrlib.tests.test_mail_client',
3778
'bzrlib.tests.test_matchers',
3779
'bzrlib.tests.test_memorytree',
3780
'bzrlib.tests.test_merge',
3781
'bzrlib.tests.test_merge3',
3782
'bzrlib.tests.test_merge_core',
3783
'bzrlib.tests.test_merge_directive',
3784
'bzrlib.tests.test_missing',
3785
'bzrlib.tests.test_msgeditor',
3786
'bzrlib.tests.test_multiparent',
3787
'bzrlib.tests.test_mutabletree',
3788
'bzrlib.tests.test_nonascii',
3789
'bzrlib.tests.test_options',
3790
'bzrlib.tests.test_osutils',
3791
'bzrlib.tests.test_osutils_encodings',
3792
'bzrlib.tests.test_pack',
3793
'bzrlib.tests.test_patch',
3794
'bzrlib.tests.test_patches',
3795
'bzrlib.tests.test_permissions',
3796
'bzrlib.tests.test_plugins',
3797
'bzrlib.tests.test_progress',
3798
'bzrlib.tests.test_read_bundle',
3799
'bzrlib.tests.test_reconcile',
3800
'bzrlib.tests.test_reconfigure',
3801
'bzrlib.tests.test_registry',
3802
'bzrlib.tests.test_remote',
3803
'bzrlib.tests.test_rename_map',
3804
'bzrlib.tests.test_repository',
3805
'bzrlib.tests.test_revert',
3806
'bzrlib.tests.test_revision',
3807
'bzrlib.tests.test_revisionspec',
3808
'bzrlib.tests.test_revisiontree',
3809
'bzrlib.tests.test_rio',
3810
'bzrlib.tests.test_rules',
3811
'bzrlib.tests.test_sampler',
3812
'bzrlib.tests.test_scenarios',
3813
'bzrlib.tests.test_script',
3814
'bzrlib.tests.test_selftest',
3815
'bzrlib.tests.test_serializer',
3816
'bzrlib.tests.test_setup',
3817
'bzrlib.tests.test_sftp_transport',
3818
'bzrlib.tests.test_shelf',
3819
'bzrlib.tests.test_shelf_ui',
3820
'bzrlib.tests.test_smart',
3821
'bzrlib.tests.test_smart_add',
3822
'bzrlib.tests.test_smart_request',
3823
'bzrlib.tests.test_smart_transport',
3824
'bzrlib.tests.test_smtp_connection',
3825
'bzrlib.tests.test_source',
3826
'bzrlib.tests.test_ssh_transport',
3827
'bzrlib.tests.test_status',
3828
'bzrlib.tests.test_store',
3829
'bzrlib.tests.test_strace',
3830
'bzrlib.tests.test_subsume',
3831
'bzrlib.tests.test_switch',
3832
'bzrlib.tests.test_symbol_versioning',
3833
'bzrlib.tests.test_tag',
3834
'bzrlib.tests.test_test_server',
3835
'bzrlib.tests.test_testament',
3836
'bzrlib.tests.test_textfile',
3837
'bzrlib.tests.test_textmerge',
3838
'bzrlib.tests.test_timestamp',
3839
'bzrlib.tests.test_trace',
3840
'bzrlib.tests.test_transactions',
3841
'bzrlib.tests.test_transform',
3842
'bzrlib.tests.test_transport',
3843
'bzrlib.tests.test_transport_log',
3844
'bzrlib.tests.test_tree',
3845
'bzrlib.tests.test_treebuilder',
3846
'bzrlib.tests.test_treeshape',
3847
'bzrlib.tests.test_tsort',
3848
'bzrlib.tests.test_tuned_gzip',
3849
'bzrlib.tests.test_ui',
3850
'bzrlib.tests.test_uncommit',
3851
'bzrlib.tests.test_upgrade',
3852
'bzrlib.tests.test_upgrade_stacked',
3853
'bzrlib.tests.test_urlutils',
3854
'bzrlib.tests.test_version',
3855
'bzrlib.tests.test_version_info',
3856
'bzrlib.tests.test_versionedfile',
3857
'bzrlib.tests.test_weave',
3858
'bzrlib.tests.test_whitebox',
3859
'bzrlib.tests.test_win32utils',
3860
'bzrlib.tests.test_workingtree',
3861
'bzrlib.tests.test_workingtree_4',
3862
'bzrlib.tests.test_wsgi',
3863
'bzrlib.tests.test_xml',
3867
def _test_suite_modules_to_doctest():
3868
"""Return the list of modules to doctest."""
3870
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3874
'bzrlib.branchbuilder',
3875
'bzrlib.decorators',
3878
'bzrlib.iterablefile',
3882
'bzrlib.symbol_versioning',
3884
'bzrlib.tests.fixtures',
3886
'bzrlib.transport.http',
3887
'bzrlib.version_info_formats.format_custom',
3891
def test_suite(keep_only=None, starting_with=None):
3892
"""Build and return TestSuite for the whole of bzrlib.
3894
:param keep_only: A list of test ids limiting the suite returned.
3896
:param starting_with: An id limiting the suite returned to the tests
3899
This function can be replaced if you need to change the default test
3900
suite on a global basis, but it is not encouraged.
3903
loader = TestUtil.TestLoader()
3905
if keep_only is not None:
3906
id_filter = TestIdList(keep_only)
3908
# We take precedence over keep_only because *at loading time* using
3909
# both options means we will load less tests for the same final result.
3910
def interesting_module(name):
3911
for start in starting_with:
3913
# Either the module name starts with the specified string
3914
name.startswith(start)
3915
# or it may contain tests starting with the specified string
3916
or start.startswith(name)
3920
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3922
elif keep_only is not None:
3923
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3924
def interesting_module(name):
3925
return id_filter.refers_to(name)
3928
loader = TestUtil.TestLoader()
3929
def interesting_module(name):
3930
# No filtering, all modules are interesting
3933
suite = loader.suiteClass()
3935
# modules building their suite with loadTestsFromModuleNames
3936
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3938
for mod in _test_suite_modules_to_doctest():
3939
if not interesting_module(mod):
3940
# No tests to keep here, move along
3943
# note that this really does mean "report only" -- doctest
3944
# still runs the rest of the examples
3945
doc_suite = doctest.DocTestSuite(mod,
3946
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3947
except ValueError, e:
3948
print '**failed to get doctest for: %s\n%s' % (mod, e)
3950
if len(doc_suite._tests) == 0:
3951
raise errors.BzrError("no doctests found in %s" % (mod,))
3952
suite.addTest(doc_suite)
3954
default_encoding = sys.getdefaultencoding()
3955
for name, plugin in bzrlib.plugin.plugins().items():
3956
if not interesting_module(plugin.module.__name__):
3958
plugin_suite = plugin.test_suite()
3959
# We used to catch ImportError here and turn it into just a warning,
3960
# but really if you don't have --no-plugins this should be a failure.
3961
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3962
if plugin_suite is None:
3963
plugin_suite = plugin.load_plugin_tests(loader)
3964
if plugin_suite is not None:
3965
suite.addTest(plugin_suite)
3966
if default_encoding != sys.getdefaultencoding():
3967
bzrlib.trace.warning(
3968
'Plugin "%s" tried to reset default encoding to: %s', name,
3969
sys.getdefaultencoding())
3971
sys.setdefaultencoding(default_encoding)
3973
if keep_only is not None:
3974
# Now that the referred modules have loaded their tests, keep only the
3976
suite = filter_suite_by_id_list(suite, id_filter)
3977
# Do some sanity checks on the id_list filtering
3978
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3980
# The tester has used both keep_only and starting_with, so he is
3981
# already aware that some tests are excluded from the list, there
3982
# is no need to tell him which.
3985
# Some tests mentioned in the list are not in the test suite. The
3986
# list may be out of date, report to the tester.
3987
for id in not_found:
3988
bzrlib.trace.warning('"%s" not found in the test suite', id)
3989
for id in duplicates:
3990
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3995
def multiply_scenarios(*scenarios):
3996
"""Multiply two or more iterables of scenarios.
3998
It is safe to pass scenario generators or iterators.
4000
:returns: A list of compound scenarios: the cross-product of all
4001
scenarios, with the names concatenated and the parameters
4004
return reduce(_multiply_two_scenarios, map(list, scenarios))
4007
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4008
"""Multiply two sets of scenarios.
4010
:returns: the cartesian product of the two sets of scenarios, that is
4011
a scenario for every possible combination of a left scenario and a
4015
('%s,%s' % (left_name, right_name),
4016
dict(left_dict.items() + right_dict.items()))
4017
for left_name, left_dict in scenarios_left
4018
for right_name, right_dict in scenarios_right]
4021
def multiply_tests(tests, scenarios, result):
4022
"""Multiply tests_list by scenarios into result.
4024
This is the core workhorse for test parameterisation.
4026
Typically the load_tests() method for a per-implementation test suite will
4027
call multiply_tests and return the result.
4029
:param tests: The tests to parameterise.
4030
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4031
scenario_param_dict).
4032
:param result: A TestSuite to add created tests to.
4034
This returns the passed in result TestSuite with the cross product of all
4035
the tests repeated once for each scenario. Each test is adapted by adding
4036
the scenario name at the end of its id(), and updating the test object's
4037
__dict__ with the scenario_param_dict.
4039
>>> import bzrlib.tests.test_sampler
4040
>>> r = multiply_tests(
4041
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4042
... [('one', dict(param=1)),
4043
... ('two', dict(param=2))],
4044
... TestUtil.TestSuite())
4045
>>> tests = list(iter_suite_tests(r))
4049
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4055
for test in iter_suite_tests(tests):
4056
apply_scenarios(test, scenarios, result)
4060
def apply_scenarios(test, scenarios, result):
4061
"""Apply the scenarios in scenarios to test and add to result.
4063
:param test: The test to apply scenarios to.
4064
:param scenarios: An iterable of scenarios to apply to test.
4066
:seealso: apply_scenario
4068
for scenario in scenarios:
4069
result.addTest(apply_scenario(test, scenario))
4073
def apply_scenario(test, scenario):
4074
"""Copy test and apply scenario to it.
4076
:param test: A test to adapt.
4077
:param scenario: A tuple describing the scenarion.
4078
The first element of the tuple is the new test id.
4079
The second element is a dict containing attributes to set on the
4081
:return: The adapted test.
4083
new_id = "%s(%s)" % (test.id(), scenario[0])
4084
new_test = clone_test(test, new_id)
4085
for name, value in scenario[1].items():
4086
setattr(new_test, name, value)
4090
def clone_test(test, new_id):
4091
"""Clone a test giving it a new id.
4093
:param test: The test to clone.
4094
:param new_id: The id to assign to it.
4095
:return: The new test.
4097
new_test = copy.copy(test)
4098
new_test.id = lambda: new_id
4099
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4100
# causes cloned tests to share the 'details' dict. This makes it hard to
4101
# read the test output for parameterized tests, because tracebacks will be
4102
# associated with irrelevant tests.
4104
details = new_test._TestCase__details
4105
except AttributeError:
4106
# must be a different version of testtools than expected. Do nothing.
4109
# Reset the '__details' dict.
4110
new_test._TestCase__details = {}
4114
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4116
"""Helper for permutating tests against an extension module.
4118
This is meant to be used inside a modules 'load_tests()' function. It will
4119
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4120
against both implementations. Setting 'test.module' to the appropriate
4121
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4123
:param standard_tests: A test suite to permute
4124
:param loader: A TestLoader
4125
:param py_module_name: The python path to a python module that can always
4126
be loaded, and will be considered the 'python' implementation. (eg
4127
'bzrlib._chk_map_py')
4128
:param ext_module_name: The python path to an extension module. If the
4129
module cannot be loaded, a single test will be added, which notes that
4130
the module is not available. If it can be loaded, all standard_tests
4131
will be run against that module.
4132
:return: (suite, feature) suite is a test-suite that has all the permuted
4133
tests. feature is the Feature object that can be used to determine if
4134
the module is available.
4137
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4139
('python', {'module': py_module}),
4141
suite = loader.suiteClass()
4142
feature = ModuleAvailableFeature(ext_module_name)
4143
if feature.available():
4144
scenarios.append(('C', {'module': feature.module}))
4146
# the compiled module isn't available, so we add a failing test
4147
class FailWithoutFeature(TestCase):
4148
def test_fail(self):
4149
self.requireFeature(feature)
4150
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4151
result = multiply_tests(standard_tests, scenarios, suite)
4152
return result, feature
4155
def _rmtree_temp_dir(dirname, test_id=None):
4156
# If LANG=C we probably have created some bogus paths
4157
# which rmtree(unicode) will fail to delete
4158
# so make sure we are using rmtree(str) to delete everything
4159
# except on win32, where rmtree(str) will fail
4160
# since it doesn't have the property of byte-stream paths
4161
# (they are either ascii or mbcs)
4162
if sys.platform == 'win32':
4163
# make sure we are using the unicode win32 api
4164
dirname = unicode(dirname)
4166
dirname = dirname.encode(sys.getfilesystemencoding())
4168
osutils.rmtree(dirname)
4170
# We don't want to fail here because some useful display will be lost
4171
# otherwise. Polluting the tmp dir is bad, but not giving all the
4172
# possible info to the test runner is even worse.
4174
ui.ui_factory.clear_term()
4175
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4176
# Ugly, but the last thing we want here is fail, so bear with it.
4177
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4178
).encode('ascii', 'replace')
4179
sys.stderr.write('Unable to remove testing dir %s\n%s'
4180
% (os.path.basename(dirname), printable_e))
4183
class Feature(object):
4184
"""An operating system Feature."""
4187
self._available = None
4189
def available(self):
4190
"""Is the feature available?
4192
:return: True if the feature is available.
4194
if self._available is None:
4195
self._available = self._probe()
4196
return self._available
4199
"""Implement this method in concrete features.
4201
:return: True if the feature is available.
4203
raise NotImplementedError
4206
if getattr(self, 'feature_name', None):
4207
return self.feature_name()
4208
return self.__class__.__name__
4211
class _SymlinkFeature(Feature):
4214
return osutils.has_symlinks()
4216
def feature_name(self):
4219
SymlinkFeature = _SymlinkFeature()
4222
class _HardlinkFeature(Feature):
4225
return osutils.has_hardlinks()
4227
def feature_name(self):
4230
HardlinkFeature = _HardlinkFeature()
4233
class _OsFifoFeature(Feature):
4236
return getattr(os, 'mkfifo', None)
4238
def feature_name(self):
4239
return 'filesystem fifos'
4241
OsFifoFeature = _OsFifoFeature()
4244
class _UnicodeFilenameFeature(Feature):
4245
"""Does the filesystem support Unicode filenames?"""
4249
# Check for character combinations unlikely to be covered by any
4250
# single non-unicode encoding. We use the characters
4251
# - greek small letter alpha (U+03B1) and
4252
# - braille pattern dots-123456 (U+283F).
4253
os.stat(u'\u03b1\u283f')
4254
except UnicodeEncodeError:
4256
except (IOError, OSError):
4257
# The filesystem allows the Unicode filename but the file doesn't
4261
# The filesystem allows the Unicode filename and the file exists,
4265
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4268
class _CompatabilityThunkFeature(Feature):
4269
"""This feature is just a thunk to another feature.
4271
It issues a deprecation warning if it is accessed, to let you know that you
4272
should really use a different feature.
4275
def __init__(self, dep_version, module, name,
4276
replacement_name, replacement_module=None):
4277
super(_CompatabilityThunkFeature, self).__init__()
4278
self._module = module
4279
if replacement_module is None:
4280
replacement_module = module
4281
self._replacement_module = replacement_module
4283
self._replacement_name = replacement_name
4284
self._dep_version = dep_version
4285
self._feature = None
4288
if self._feature is None:
4289
depr_msg = self._dep_version % ('%s.%s'
4290
% (self._module, self._name))
4291
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4292
self._replacement_name)
4293
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4294
# Import the new feature and use it as a replacement for the
4296
mod = __import__(self._replacement_module, {}, {},
4297
[self._replacement_name])
4298
self._feature = getattr(mod, self._replacement_name)
4302
return self._feature._probe()
4305
class ModuleAvailableFeature(Feature):
4306
"""This is a feature than describes a module we want to be available.
4308
Declare the name of the module in __init__(), and then after probing, the
4309
module will be available as 'self.module'.
4311
:ivar module: The module if it is available, else None.
4314
def __init__(self, module_name):
4315
super(ModuleAvailableFeature, self).__init__()
4316
self.module_name = module_name
4320
self._module = __import__(self.module_name, {}, {}, [''])
4327
if self.available(): # Make sure the probe has been done
4331
def feature_name(self):
4332
return self.module_name
4335
# This is kept here for compatibility, it is recommended to use
4336
# 'bzrlib.tests.feature.paramiko' instead
4337
ParamikoFeature = _CompatabilityThunkFeature(
4338
deprecated_in((2,1,0)),
4339
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4342
def probe_unicode_in_user_encoding():
4343
"""Try to encode several unicode strings to use in unicode-aware tests.
4344
Return first successfull match.
4346
:return: (unicode value, encoded plain string value) or (None, None)
4348
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4349
for uni_val in possible_vals:
4351
str_val = uni_val.encode(osutils.get_user_encoding())
4352
except UnicodeEncodeError:
4353
# Try a different character
4356
return uni_val, str_val
4360
def probe_bad_non_ascii(encoding):
4361
"""Try to find [bad] character with code [128..255]
4362
that cannot be decoded to unicode in some encoding.
4363
Return None if all non-ascii characters is valid
4366
for i in xrange(128, 256):
4369
char.decode(encoding)
4370
except UnicodeDecodeError:
4375
class _HTTPSServerFeature(Feature):
4376
"""Some tests want an https Server, check if one is available.
4378
Right now, the only way this is available is under python2.6 which provides
4389
def feature_name(self):
4390
return 'HTTPSServer'
4393
HTTPSServerFeature = _HTTPSServerFeature()
4396
class _UnicodeFilename(Feature):
4397
"""Does the filesystem support Unicode filenames?"""
4402
except UnicodeEncodeError:
4404
except (IOError, OSError):
4405
# The filesystem allows the Unicode filename but the file doesn't
4409
# The filesystem allows the Unicode filename and the file exists,
4413
UnicodeFilename = _UnicodeFilename()
4416
class _ByteStringNamedFilesystem(Feature):
4417
"""Is the filesystem based on bytes?"""
4420
if os.name == "posix":
4424
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4427
class _UTF8Filesystem(Feature):
4428
"""Is the filesystem UTF-8?"""
4431
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4435
UTF8Filesystem = _UTF8Filesystem()
4438
class _BreakinFeature(Feature):
4439
"""Does this platform support the breakin feature?"""
4442
from bzrlib import breakin
4443
if breakin.determine_signal() is None:
4445
if sys.platform == 'win32':
4446
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4447
# We trigger SIGBREAK via a Console api so we need ctypes to
4448
# access the function
4455
def feature_name(self):
4456
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4459
BreakinFeature = _BreakinFeature()
4462
class _CaseInsCasePresFilenameFeature(Feature):
4463
"""Is the file-system case insensitive, but case-preserving?"""
4466
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4468
# first check truly case-preserving for created files, then check
4469
# case insensitive when opening existing files.
4470
name = osutils.normpath(name)
4471
base, rel = osutils.split(name)
4472
found_rel = osutils.canonical_relpath(base, name)
4473
return (found_rel == rel
4474
and os.path.isfile(name.upper())
4475
and os.path.isfile(name.lower()))
4480
def feature_name(self):
4481
return "case-insensitive case-preserving filesystem"
4483
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4486
class _CaseInsensitiveFilesystemFeature(Feature):
4487
"""Check if underlying filesystem is case-insensitive but *not* case
4490
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4491
# more likely to be case preserving, so this case is rare.
4494
if CaseInsCasePresFilenameFeature.available():
4497
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4498
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4499
TestCaseWithMemoryTransport.TEST_ROOT = root
4501
root = TestCaseWithMemoryTransport.TEST_ROOT
4502
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4504
name_a = osutils.pathjoin(tdir, 'a')
4505
name_A = osutils.pathjoin(tdir, 'A')
4507
result = osutils.isdir(name_A)
4508
_rmtree_temp_dir(tdir)
4511
def feature_name(self):
4512
return 'case-insensitive filesystem'
4514
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4517
class _CaseSensitiveFilesystemFeature(Feature):
4520
if CaseInsCasePresFilenameFeature.available():
4522
elif CaseInsensitiveFilesystemFeature.available():
4527
def feature_name(self):
4528
return 'case-sensitive filesystem'
4530
# new coding style is for feature instances to be lowercase
4531
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4534
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4535
SubUnitFeature = _CompatabilityThunkFeature(
4536
deprecated_in((2,1,0)),
4537
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4538
# Only define SubUnitBzrRunner if subunit is available.
4540
from subunit import TestProtocolClient
4541
from subunit.test_results import AutoTimingTestResultDecorator
4542
class SubUnitBzrProtocolClient(TestProtocolClient):
4544
def addSuccess(self, test, details=None):
4545
# The subunit client always includes the details in the subunit
4546
# stream, but we don't want to include it in ours.
4547
if details is not None and 'log' in details:
4549
return super(SubUnitBzrProtocolClient, self).addSuccess(
4552
class SubUnitBzrRunner(TextTestRunner):
4553
def run(self, test):
4554
result = AutoTimingTestResultDecorator(
4555
SubUnitBzrProtocolClient(self.stream))
4561
class _PosixPermissionsFeature(Feature):
4565
# create temporary file and check if specified perms are maintained.
4568
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4569
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4572
os.chmod(name, write_perms)
4574
read_perms = os.stat(name).st_mode & 0777
4576
return (write_perms == read_perms)
4578
return (os.name == 'posix') and has_perms()
4580
def feature_name(self):
4581
return 'POSIX permissions support'
4583
posix_permissions_feature = _PosixPermissionsFeature()
added
removed
bzrlib/tests/__init__.py
