1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
67
import bzrlib.commands
68
import bzrlib.timestamp
70
import bzrlib.inventory
71
import bzrlib.iterablefile
76
# lsprof not available
78
from bzrlib.merge import merge_inner
81
from bzrlib.smart import client, request, server
83
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (
91
from bzrlib.transport import get_transport
92
import bzrlib.transport
93
from bzrlib.transport.local import LocalURLServer
94
from bzrlib.transport.memory import MemoryServer
95
from bzrlib.transport.readonly import ReadonlyServer
96
from bzrlib.trace import mutter, note
97
from bzrlib.tests import TestUtil
98
from bzrlib.tests.http_server import HttpServer
99
from bzrlib.tests.TestUtil import (
103
from bzrlib.tests.treeshape import build_tree_contents
104
import bzrlib.version_info_formats.format_custom
105
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
107
# Mark this python module as being part of the implementation
108
# of unittest: this gives us better tracebacks where the last
109
# shown frame is the test code, not our assertXYZ.
112
default_transport = LocalURLServer
115
class ExtendedTestResult(unittest._TextTestResult):
116
"""Accepts, reports and accumulates the results of running tests.
118
Compared to the unittest version this class adds support for
119
profiling, benchmarking, stopping as soon as a test fails, and
120
skipping tests. There are further-specialized subclasses for
121
different types of display.
123
When a test finishes, in whatever way, it calls one of the addSuccess,
124
addFailure or addError classes. These in turn may redirect to a more
125
specific case for the special test results supported by our extended
128
Note that just one of these objects is fed the results from many tests.
133
def __init__(self, stream, descriptions, verbosity,
137
"""Construct new TestResult.
139
:param bench_history: Optionally, a writable file object to accumulate
142
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
143
if bench_history is not None:
144
from bzrlib.version import _get_bzr_source_tree
145
src_tree = _get_bzr_source_tree()
148
revision_id = src_tree.get_parent_ids()[0]
150
# XXX: if this is a brand new tree, do the same as if there
154
# XXX: If there's no branch, what should we do?
156
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
157
self._bench_history = bench_history
158
self.ui = ui.ui_factory
159
self.num_tests = num_tests
161
self.failure_count = 0
162
self.known_failure_count = 0
164
self.not_applicable_count = 0
165
self.unsupported = {}
167
self._overall_start_time = time.time()
169
def _extractBenchmarkTime(self, testCase):
170
"""Add a benchmark time for the current test case."""
171
return getattr(testCase, "_benchtime", None)
173
def _elapsedTestTimeString(self):
174
"""Return a time string for the overall time the current test has taken."""
175
return self._formatTime(time.time() - self._start_time)
177
def _testTimeString(self, testCase):
178
benchmark_time = self._extractBenchmarkTime(testCase)
179
if benchmark_time is not None:
181
self._formatTime(benchmark_time),
182
self._elapsedTestTimeString())
184
return " %s" % self._elapsedTestTimeString()
186
def _formatTime(self, seconds):
187
"""Format seconds as milliseconds with leading spaces."""
188
# some benchmarks can take thousands of seconds to run, so we need 8
190
return "%8dms" % (1000 * seconds)
192
def _shortened_test_description(self, test):
194
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
197
def startTest(self, test):
198
unittest.TestResult.startTest(self, test)
199
self.report_test_start(test)
200
test.number = self.count
201
self._recordTestStartTime()
203
def _recordTestStartTime(self):
204
"""Record that a test has started."""
205
self._start_time = time.time()
207
def _cleanupLogFile(self, test):
208
# We can only do this if we have one of our TestCases, not if
210
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
211
if setKeepLogfile is not None:
214
def addError(self, test, err):
215
"""Tell result that test finished with an error.
217
Called from the TestCase run() method when the test
218
fails with an unexpected error.
220
self._testConcluded(test)
221
if isinstance(err[1], TestNotApplicable):
222
return self._addNotApplicable(test, err)
223
elif isinstance(err[1], UnavailableFeature):
224
return self.addNotSupported(test, err[1].args[0])
226
unittest.TestResult.addError(self, test, err)
227
self.error_count += 1
228
self.report_error(test, err)
231
self._cleanupLogFile(test)
233
def addFailure(self, test, err):
234
"""Tell result that test failed.
236
Called from the TestCase run() method when the test
237
fails because e.g. an assert() method failed.
239
self._testConcluded(test)
240
if isinstance(err[1], KnownFailure):
241
return self._addKnownFailure(test, err)
243
unittest.TestResult.addFailure(self, test, err)
244
self.failure_count += 1
245
self.report_failure(test, err)
248
self._cleanupLogFile(test)
250
def addSuccess(self, test):
251
"""Tell result that test completed successfully.
253
Called from the TestCase run()
255
self._testConcluded(test)
256
if self._bench_history is not None:
257
benchmark_time = self._extractBenchmarkTime(test)
258
if benchmark_time is not None:
259
self._bench_history.write("%s %s\n" % (
260
self._formatTime(benchmark_time),
262
self.report_success(test)
263
self._cleanupLogFile(test)
264
unittest.TestResult.addSuccess(self, test)
265
test._log_contents = ''
267
def _testConcluded(self, test):
268
"""Common code when a test has finished.
270
Called regardless of whether it succeded, failed, etc.
274
def _addKnownFailure(self, test, err):
275
self.known_failure_count += 1
276
self.report_known_failure(test, err)
278
def addNotSupported(self, test, feature):
279
"""The test will not be run because of a missing feature.
281
# this can be called in two different ways: it may be that the
282
# test started running, and then raised (through addError)
283
# UnavailableFeature. Alternatively this method can be called
284
# while probing for features before running the tests; in that
285
# case we will see startTest and stopTest, but the test will never
287
self.unsupported.setdefault(str(feature), 0)
288
self.unsupported[str(feature)] += 1
289
self.report_unsupported(test, feature)
291
def addSkip(self, test, reason):
292
"""A test has not run for 'reason'."""
294
self.report_skip(test, reason)
296
def _addNotApplicable(self, test, skip_excinfo):
297
if isinstance(skip_excinfo[1], TestNotApplicable):
298
self.not_applicable_count += 1
299
self.report_not_applicable(test, skip_excinfo)
302
except KeyboardInterrupt:
305
self.addError(test, test.exc_info())
307
# seems best to treat this as success from point-of-view of unittest
308
# -- it actually does nothing so it barely matters :)
309
unittest.TestResult.addSuccess(self, test)
310
test._log_contents = ''
312
def printErrorList(self, flavour, errors):
313
for test, err in errors:
314
self.stream.writeln(self.separator1)
315
self.stream.write("%s: " % flavour)
316
self.stream.writeln(self.getDescription(test))
317
if getattr(test, '_get_log', None) is not None:
318
self.stream.write('\n')
320
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
321
self.stream.write('\n')
322
self.stream.write(test._get_log())
323
self.stream.write('\n')
325
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
326
self.stream.write('\n')
327
self.stream.writeln(self.separator2)
328
self.stream.writeln("%s" % err)
333
def report_cleaning_up(self):
336
def report_success(self, test):
339
def wasStrictlySuccessful(self):
340
if self.unsupported or self.known_failure_count:
342
return self.wasSuccessful()
345
class TextTestResult(ExtendedTestResult):
346
"""Displays progress and results of tests in text form"""
348
def __init__(self, stream, descriptions, verbosity,
353
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
354
bench_history, num_tests)
356
self.pb = self.ui.nested_progress_bar()
357
self._supplied_pb = False
360
self._supplied_pb = True
361
self.pb.show_pct = False
362
self.pb.show_spinner = False
363
self.pb.show_eta = False,
364
self.pb.show_count = False
365
self.pb.show_bar = False
367
def report_starting(self):
368
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
370
def _progress_prefix_text(self):
371
# the longer this text, the less space we have to show the test
373
a = '[%d' % self.count # total that have been run
374
# tests skipped as known not to be relevant are not important enough
376
## if self.skip_count:
377
## a += ', %d skip' % self.skip_count
378
## if self.known_failure_count:
379
## a += '+%dX' % self.known_failure_count
380
if self.num_tests is not None:
381
a +='/%d' % self.num_tests
383
runtime = time.time() - self._overall_start_time
385
a += '%dm%ds' % (runtime / 60, runtime % 60)
389
a += ', %d err' % self.error_count
390
if self.failure_count:
391
a += ', %d fail' % self.failure_count
393
a += ', %d missing' % len(self.unsupported)
397
def report_test_start(self, test):
400
self._progress_prefix_text()
402
+ self._shortened_test_description(test))
404
def _test_description(self, test):
405
return self._shortened_test_description(test)
407
def report_error(self, test, err):
408
self.pb.note('ERROR: %s\n %s\n',
409
self._test_description(test),
413
def report_failure(self, test, err):
414
self.pb.note('FAIL: %s\n %s\n',
415
self._test_description(test),
419
def report_known_failure(self, test, err):
420
self.pb.note('XFAIL: %s\n%s\n',
421
self._test_description(test), err[1])
423
def report_skip(self, test, reason):
426
def report_not_applicable(self, test, skip_excinfo):
429
def report_unsupported(self, test, feature):
430
"""test cannot be run because feature is missing."""
432
def report_cleaning_up(self):
433
self.pb.update('Cleaning up')
436
if not self._supplied_pb:
440
class VerboseTestResult(ExtendedTestResult):
441
"""Produce long output, with one line per test run plus times"""
443
def _ellipsize_to_right(self, a_string, final_width):
444
"""Truncate and pad a string, keeping the right hand side"""
445
if len(a_string) > final_width:
446
result = '...' + a_string[3-final_width:]
449
return result.ljust(final_width)
451
def report_starting(self):
452
self.stream.write('running %d tests...\n' % self.num_tests)
454
def report_test_start(self, test):
456
name = self._shortened_test_description(test)
457
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
458
# numbers, plus a trailing blank
459
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
460
self.stream.write(self._ellipsize_to_right(name,
461
osutils.terminal_width()-30))
464
def _error_summary(self, err):
466
return '%s%s' % (indent, err[1])
468
def report_error(self, test, err):
469
self.stream.writeln('ERROR %s\n%s'
470
% (self._testTimeString(test),
471
self._error_summary(err)))
473
def report_failure(self, test, err):
474
self.stream.writeln(' FAIL %s\n%s'
475
% (self._testTimeString(test),
476
self._error_summary(err)))
478
def report_known_failure(self, test, err):
479
self.stream.writeln('XFAIL %s\n%s'
480
% (self._testTimeString(test),
481
self._error_summary(err)))
483
def report_success(self, test):
484
self.stream.writeln(' OK %s' % self._testTimeString(test))
485
for bench_called, stats in getattr(test, '_benchcalls', []):
486
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
487
stats.pprint(file=self.stream)
488
# flush the stream so that we get smooth output. This verbose mode is
489
# used to show the output in PQM.
492
def report_skip(self, test, reason):
493
self.stream.writeln(' SKIP %s\n%s'
494
% (self._testTimeString(test), reason))
496
def report_not_applicable(self, test, skip_excinfo):
497
self.stream.writeln(' N/A %s\n%s'
498
% (self._testTimeString(test),
499
self._error_summary(skip_excinfo)))
501
def report_unsupported(self, test, feature):
502
"""test cannot be run because feature is missing."""
503
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
504
%(self._testTimeString(test), feature))
507
class TextTestRunner(object):
508
stop_on_failure = False
517
self.stream = unittest._WritelnDecorator(stream)
518
self.descriptions = descriptions
519
self.verbosity = verbosity
520
self._bench_history = bench_history
521
self.list_only = list_only
524
"Run the given test case or test suite."
525
startTime = time.time()
526
if self.verbosity == 1:
527
result_class = TextTestResult
528
elif self.verbosity >= 2:
529
result_class = VerboseTestResult
530
result = result_class(self.stream,
533
bench_history=self._bench_history,
534
num_tests=test.countTestCases(),
536
result.stop_early = self.stop_on_failure
537
result.report_starting()
539
if self.verbosity >= 2:
540
self.stream.writeln("Listing tests only ...\n")
542
for t in iter_suite_tests(test):
543
self.stream.writeln("%s" % (t.id()))
545
actionTaken = "Listed"
548
from testtools import ThreadsafeForwardingResult
552
if type(result) == ThreadsafeForwardingResult:
553
test.run(BZRTransformingResult(result))
556
run = result.testsRun
558
stopTime = time.time()
559
timeTaken = stopTime - startTime
561
self.stream.writeln(result.separator2)
562
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
563
run, run != 1 and "s" or "", timeTaken))
564
self.stream.writeln()
565
if not result.wasSuccessful():
566
self.stream.write("FAILED (")
567
failed, errored = map(len, (result.failures, result.errors))
569
self.stream.write("failures=%d" % failed)
571
if failed: self.stream.write(", ")
572
self.stream.write("errors=%d" % errored)
573
if result.known_failure_count:
574
if failed or errored: self.stream.write(", ")
575
self.stream.write("known_failure_count=%d" %
576
result.known_failure_count)
577
self.stream.writeln(")")
579
if result.known_failure_count:
580
self.stream.writeln("OK (known_failures=%d)" %
581
result.known_failure_count)
583
self.stream.writeln("OK")
584
if result.skip_count > 0:
585
skipped = result.skip_count
586
self.stream.writeln('%d test%s skipped' %
587
(skipped, skipped != 1 and "s" or ""))
588
if result.unsupported:
589
for feature, count in sorted(result.unsupported.items()):
590
self.stream.writeln("Missing feature '%s' skipped %d tests." %
596
def iter_suite_tests(suite):
597
"""Return all tests in a suite, recursing through nested suites"""
598
if isinstance(suite, unittest.TestCase):
600
elif isinstance(suite, unittest.TestSuite):
602
for r in iter_suite_tests(item):
605
raise Exception('unknown type %r for object %r'
606
% (type(suite), suite))
609
class TestSkipped(Exception):
610
"""Indicates that a test was intentionally skipped, rather than failing."""
613
class TestNotApplicable(TestSkipped):
614
"""A test is not applicable to the situation where it was run.
616
This is only normally raised by parameterized tests, if they find that
617
the instance they're constructed upon does not support one aspect
622
class KnownFailure(AssertionError):
623
"""Indicates that a test failed in a precisely expected manner.
625
Such failures dont block the whole test suite from passing because they are
626
indicators of partially completed code or of future work. We have an
627
explicit error for them so that we can ensure that they are always visible:
628
KnownFailures are always shown in the output of bzr selftest.
632
class UnavailableFeature(Exception):
633
"""A feature required for this test was not available.
635
The feature should be used to construct the exception.
639
class CommandFailed(Exception):
643
class StringIOWrapper(object):
644
"""A wrapper around cStringIO which just adds an encoding attribute.
646
Internally we can check sys.stdout to see what the output encoding
647
should be. However, cStringIO has no encoding attribute that we can
648
set. So we wrap it instead.
653
def __init__(self, s=None):
655
self.__dict__['_cstring'] = StringIO(s)
657
self.__dict__['_cstring'] = StringIO()
659
def __getattr__(self, name, getattr=getattr):
660
return getattr(self.__dict__['_cstring'], name)
662
def __setattr__(self, name, val):
663
if name == 'encoding':
664
self.__dict__['encoding'] = val
666
return setattr(self._cstring, name, val)
669
class TestUIFactory(ui.CLIUIFactory):
670
"""A UI Factory for testing.
672
Hide the progress bar but emit note()s.
674
Allows get_password to be tested without real tty attached.
681
super(TestUIFactory, self).__init__()
682
if stdin is not None:
683
# We use a StringIOWrapper to be able to test various
684
# encodings, but the user is still responsible to
685
# encode the string and to set the encoding attribute
686
# of StringIOWrapper.
687
self.stdin = StringIOWrapper(stdin)
689
self.stdout = sys.stdout
693
self.stderr = sys.stderr
698
"""See progress.ProgressBar.clear()."""
700
def clear_term(self):
701
"""See progress.ProgressBar.clear_term()."""
703
def clear_term(self):
704
"""See progress.ProgressBar.clear_term()."""
707
"""See progress.ProgressBar.finished()."""
709
def note(self, fmt_string, *args, **kwargs):
710
"""See progress.ProgressBar.note()."""
711
self.stdout.write((fmt_string + "\n") % args)
713
def progress_bar(self):
716
def nested_progress_bar(self):
719
def update(self, message, count=None, total=None):
720
"""See progress.ProgressBar.update()."""
722
def get_non_echoed_password(self, prompt):
723
"""Get password from stdin without trying to handle the echo mode"""
725
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
726
password = self.stdin.readline()
729
if password[-1] == '\n':
730
password = password[:-1]
734
def _report_leaked_threads():
735
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
736
TestCase._first_thread_leaker_id,
737
TestCase._leaking_threads_tests)
740
class TestCase(unittest.TestCase):
741
"""Base class for bzr unit tests.
743
Tests that need access to disk resources should subclass
744
TestCaseInTempDir not TestCase.
746
Error and debug log messages are redirected from their usual
747
location into a temporary file, the contents of which can be
748
retrieved by _get_log(). We use a real OS file, not an in-memory object,
749
so that it can also capture file IO. When the test completes this file
750
is read into memory and removed from disk.
752
There are also convenience functions to invoke bzr's command-line
753
routine, and to build and check bzr trees.
755
In addition to the usual method of overriding tearDown(), this class also
756
allows subclasses to register functions into the _cleanups list, which is
757
run in order as the object is torn down. It's less likely this will be
758
accidentally overlooked.
761
_active_threads = None
762
_leaking_threads_tests = 0
763
_first_thread_leaker_id = None
764
_log_file_name = None
766
_keep_log_file = False
767
# record lsprof data when performing benchmark calls.
768
_gather_lsprof_in_benchmarks = False
769
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
770
'_log_contents', '_log_file_name', '_benchtime',
771
'_TestCase__testMethodName')
773
def __init__(self, methodName='testMethod'):
774
super(TestCase, self).__init__(methodName)
776
self._bzr_test_setUp_run = False
777
self._bzr_test_tearDown_run = False
780
unittest.TestCase.setUp(self)
781
self._bzr_test_setUp_run = True
782
self._cleanEnvironment()
785
self._benchcalls = []
786
self._benchtime = None
788
self._clear_debug_flags()
789
TestCase._active_threads = threading.activeCount()
790
self.addCleanup(self._check_leaked_threads)
795
pdb.Pdb().set_trace(sys._getframe().f_back)
798
absent_attr = object()
799
exc_info = getattr(self, '_exc_info', absent_attr)
800
if exc_info is absent_attr:
801
exc_info = getattr(self, '_TestCase__exc_info')
804
def _check_leaked_threads(self):
805
active = threading.activeCount()
806
leaked_threads = active - TestCase._active_threads
807
TestCase._active_threads = active
809
TestCase._leaking_threads_tests += 1
810
if TestCase._first_thread_leaker_id is None:
811
TestCase._first_thread_leaker_id = self.id()
812
# we're not specifically told when all tests are finished.
813
# This will do. We use a function to avoid keeping a reference
814
# to a TestCase object.
815
atexit.register(_report_leaked_threads)
817
def _clear_debug_flags(self):
818
"""Prevent externally set debug flags affecting tests.
820
Tests that want to use debug flags can just set them in the
821
debug_flags set during setup/teardown.
823
self._preserved_debug_flags = set(debug.debug_flags)
824
if 'allow_debug' not in selftest_debug_flags:
825
debug.debug_flags.clear()
826
self.addCleanup(self._restore_debug_flags)
828
def _clear_hooks(self):
829
# prevent hooks affecting tests
830
self._preserved_hooks = {}
831
for key, factory in hooks.known_hooks.items():
832
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
833
current_hooks = hooks.known_hooks_key_to_object(key)
834
self._preserved_hooks[parent] = (name, current_hooks)
835
self.addCleanup(self._restoreHooks)
836
for key, factory in hooks.known_hooks.items():
837
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
838
setattr(parent, name, factory())
839
# this hook should always be installed
840
request._install_hook()
842
def _silenceUI(self):
843
"""Turn off UI for duration of test"""
844
# by default the UI is off; tests can turn it on if they want it.
845
saved = ui.ui_factory
847
ui.ui_factory = saved
848
ui.ui_factory = ui.SilentUIFactory()
849
self.addCleanup(_restore)
851
def _ndiff_strings(self, a, b):
852
"""Return ndiff between two strings containing lines.
854
A trailing newline is added if missing to make the strings
856
if b and b[-1] != '\n':
858
if a and a[-1] != '\n':
860
difflines = difflib.ndiff(a.splitlines(True),
862
linejunk=lambda x: False,
863
charjunk=lambda x: False)
864
return ''.join(difflines)
866
def assertEqual(self, a, b, message=''):
870
except UnicodeError, e:
871
# If we can't compare without getting a UnicodeError, then
872
# obviously they are different
873
mutter('UnicodeError: %s', e)
876
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
878
pformat(a), pformat(b)))
880
assertEquals = assertEqual
882
def assertEqualDiff(self, a, b, message=None):
883
"""Assert two texts are equal, if not raise an exception.
885
This is intended for use with multi-line strings where it can
886
be hard to find the differences by eye.
888
# TODO: perhaps override assertEquals to call this for strings?
892
message = "texts not equal:\n"
894
message = 'first string is missing a final newline.\n'
896
message = 'second string is missing a final newline.\n'
897
raise AssertionError(message +
898
self._ndiff_strings(a, b))
900
def assertEqualMode(self, mode, mode_test):
901
self.assertEqual(mode, mode_test,
902
'mode mismatch %o != %o' % (mode, mode_test))
904
def assertEqualStat(self, expected, actual):
905
"""assert that expected and actual are the same stat result.
907
:param expected: A stat result.
908
:param actual: A stat result.
909
:raises AssertionError: If the expected and actual stat values differ
912
self.assertEqual(expected.st_size, actual.st_size)
913
self.assertEqual(expected.st_mtime, actual.st_mtime)
914
self.assertEqual(expected.st_ctime, actual.st_ctime)
915
self.assertEqual(expected.st_dev, actual.st_dev)
916
self.assertEqual(expected.st_ino, actual.st_ino)
917
self.assertEqual(expected.st_mode, actual.st_mode)
919
def assertLength(self, length, obj_with_len):
920
"""Assert that obj_with_len is of length length."""
921
if len(obj_with_len) != length:
922
self.fail("Incorrect length: wanted %d, got %d for %r" % (
923
length, len(obj_with_len), obj_with_len))
925
def assertPositive(self, val):
926
"""Assert that val is greater than 0."""
927
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
929
def assertNegative(self, val):
930
"""Assert that val is less than 0."""
931
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
933
def assertStartsWith(self, s, prefix):
934
if not s.startswith(prefix):
935
raise AssertionError('string %r does not start with %r' % (s, prefix))
937
def assertEndsWith(self, s, suffix):
938
"""Asserts that s ends with suffix."""
939
if not s.endswith(suffix):
940
raise AssertionError('string %r does not end with %r' % (s, suffix))
942
def assertContainsRe(self, haystack, needle_re, flags=0):
943
"""Assert that a contains something matching a regular expression."""
944
if not re.search(needle_re, haystack, flags):
945
if '\n' in haystack or len(haystack) > 60:
946
# a long string, format it in a more readable way
947
raise AssertionError(
948
'pattern "%s" not found in\n"""\\\n%s"""\n'
949
% (needle_re, haystack))
951
raise AssertionError('pattern "%s" not found in "%s"'
952
% (needle_re, haystack))
954
def assertNotContainsRe(self, haystack, needle_re, flags=0):
955
"""Assert that a does not match a regular expression"""
956
if re.search(needle_re, haystack, flags):
957
raise AssertionError('pattern "%s" found in "%s"'
958
% (needle_re, haystack))
960
def assertSubset(self, sublist, superlist):
961
"""Assert that every entry in sublist is present in superlist."""
962
missing = set(sublist) - set(superlist)
964
raise AssertionError("value(s) %r not present in container %r" %
965
(missing, superlist))
967
def assertListRaises(self, excClass, func, *args, **kwargs):
968
"""Fail unless excClass is raised when the iterator from func is used.
970
Many functions can return generators this makes sure
971
to wrap them in a list() call to make sure the whole generator
972
is run, and that the proper exception is raised.
975
list(func(*args, **kwargs))
979
if getattr(excClass,'__name__', None) is not None:
980
excName = excClass.__name__
982
excName = str(excClass)
983
raise self.failureException, "%s not raised" % excName
985
def assertRaises(self, excClass, callableObj, *args, **kwargs):
986
"""Assert that a callable raises a particular exception.
988
:param excClass: As for the except statement, this may be either an
989
exception class, or a tuple of classes.
990
:param callableObj: A callable, will be passed ``*args`` and
993
Returns the exception so that you can examine it.
996
callableObj(*args, **kwargs)
1000
if getattr(excClass,'__name__', None) is not None:
1001
excName = excClass.__name__
1004
excName = str(excClass)
1005
raise self.failureException, "%s not raised" % excName
1007
def assertIs(self, left, right, message=None):
1008
if not (left is right):
1009
if message is not None:
1010
raise AssertionError(message)
1012
raise AssertionError("%r is not %r." % (left, right))
1014
def assertIsNot(self, left, right, message=None):
1016
if message is not None:
1017
raise AssertionError(message)
1019
raise AssertionError("%r is %r." % (left, right))
1021
def assertTransportMode(self, transport, path, mode):
1022
"""Fail if a path does not have mode mode.
1024
If modes are not supported on this transport, the assertion is ignored.
1026
if not transport._can_roundtrip_unix_modebits():
1028
path_stat = transport.stat(path)
1029
actual_mode = stat.S_IMODE(path_stat.st_mode)
1030
self.assertEqual(mode, actual_mode,
1031
'mode of %r incorrect (%s != %s)'
1032
% (path, oct(mode), oct(actual_mode)))
1034
def assertIsSameRealPath(self, path1, path2):
1035
"""Fail if path1 and path2 points to different files"""
1036
self.assertEqual(osutils.realpath(path1),
1037
osutils.realpath(path2),
1038
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1040
def assertIsInstance(self, obj, kls):
1041
"""Fail if obj is not an instance of kls"""
1042
if not isinstance(obj, kls):
1043
self.fail("%r is an instance of %s rather than %s" % (
1044
obj, obj.__class__, kls))
1046
def expectFailure(self, reason, assertion, *args, **kwargs):
1047
"""Invoke a test, expecting it to fail for the given reason.
1049
This is for assertions that ought to succeed, but currently fail.
1050
(The failure is *expected* but not *wanted*.) Please be very precise
1051
about the failure you're expecting. If a new bug is introduced,
1052
AssertionError should be raised, not KnownFailure.
1054
Frequently, expectFailure should be followed by an opposite assertion.
1057
Intended to be used with a callable that raises AssertionError as the
1058
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1060
Raises KnownFailure if the test fails. Raises AssertionError if the
1065
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1067
self.assertEqual(42, dynamic_val)
1069
This means that a dynamic_val of 54 will cause the test to raise
1070
a KnownFailure. Once math is fixed and the expectFailure is removed,
1071
only a dynamic_val of 42 will allow the test to pass. Anything other
1072
than 54 or 42 will cause an AssertionError.
1075
assertion(*args, **kwargs)
1076
except AssertionError:
1077
raise KnownFailure(reason)
1079
self.fail('Unexpected success. Should have failed: %s' % reason)
1081
def assertFileEqual(self, content, path):
1082
"""Fail if path does not contain 'content'."""
1083
self.failUnlessExists(path)
1084
f = file(path, 'rb')
1089
self.assertEqualDiff(content, s)
1091
def failUnlessExists(self, path):
1092
"""Fail unless path or paths, which may be abs or relative, exist."""
1093
if not isinstance(path, basestring):
1095
self.failUnlessExists(p)
1097
self.failUnless(osutils.lexists(path),path+" does not exist")
1099
def failIfExists(self, path):
1100
"""Fail if path or paths, which may be abs or relative, exist."""
1101
if not isinstance(path, basestring):
1103
self.failIfExists(p)
1105
self.failIf(osutils.lexists(path),path+" exists")
1107
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1108
"""A helper for callDeprecated and applyDeprecated.
1110
:param a_callable: A callable to call.
1111
:param args: The positional arguments for the callable
1112
:param kwargs: The keyword arguments for the callable
1113
:return: A tuple (warnings, result). result is the result of calling
1114
a_callable(``*args``, ``**kwargs``).
1117
def capture_warnings(msg, cls=None, stacklevel=None):
1118
# we've hooked into a deprecation specific callpath,
1119
# only deprecations should getting sent via it.
1120
self.assertEqual(cls, DeprecationWarning)
1121
local_warnings.append(msg)
1122
original_warning_method = symbol_versioning.warn
1123
symbol_versioning.set_warning_method(capture_warnings)
1125
result = a_callable(*args, **kwargs)
1127
symbol_versioning.set_warning_method(original_warning_method)
1128
return (local_warnings, result)
1130
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1131
"""Call a deprecated callable without warning the user.
1133
Note that this only captures warnings raised by symbol_versioning.warn,
1134
not other callers that go direct to the warning module.
1136
To test that a deprecated method raises an error, do something like
1139
self.assertRaises(errors.ReservedId,
1140
self.applyDeprecated,
1141
deprecated_in((1, 5, 0)),
1145
:param deprecation_format: The deprecation format that the callable
1146
should have been deprecated with. This is the same type as the
1147
parameter to deprecated_method/deprecated_function. If the
1148
callable is not deprecated with this format, an assertion error
1150
:param a_callable: A callable to call. This may be a bound method or
1151
a regular function. It will be called with ``*args`` and
1153
:param args: The positional arguments for the callable
1154
:param kwargs: The keyword arguments for the callable
1155
:return: The result of a_callable(``*args``, ``**kwargs``)
1157
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1159
expected_first_warning = symbol_versioning.deprecation_string(
1160
a_callable, deprecation_format)
1161
if len(call_warnings) == 0:
1162
self.fail("No deprecation warning generated by call to %s" %
1164
self.assertEqual(expected_first_warning, call_warnings[0])
1167
def callCatchWarnings(self, fn, *args, **kw):
1168
"""Call a callable that raises python warnings.
1170
The caller's responsible for examining the returned warnings.
1172
If the callable raises an exception, the exception is not
1173
caught and propagates up to the caller. In that case, the list
1174
of warnings is not available.
1176
:returns: ([warning_object, ...], fn_result)
1178
# XXX: This is not perfect, because it completely overrides the
1179
# warnings filters, and some code may depend on suppressing particular
1180
# warnings. It's the easiest way to insulate ourselves from -Werror,
1181
# though. -- Andrew, 20071062
1183
def _catcher(message, category, filename, lineno, file=None, line=None):
1184
# despite the name, 'message' is normally(?) a Warning subclass
1186
wlist.append(message)
1187
saved_showwarning = warnings.showwarning
1188
saved_filters = warnings.filters
1190
warnings.showwarning = _catcher
1191
warnings.filters = []
1192
result = fn(*args, **kw)
1194
warnings.showwarning = saved_showwarning
1195
warnings.filters = saved_filters
1196
return wlist, result
1198
def callDeprecated(self, expected, callable, *args, **kwargs):
1199
"""Assert that a callable is deprecated in a particular way.
1201
This is a very precise test for unusual requirements. The
1202
applyDeprecated helper function is probably more suited for most tests
1203
as it allows you to simply specify the deprecation format being used
1204
and will ensure that that is issued for the function being called.
1206
Note that this only captures warnings raised by symbol_versioning.warn,
1207
not other callers that go direct to the warning module. To catch
1208
general warnings, use callCatchWarnings.
1210
:param expected: a list of the deprecation warnings expected, in order
1211
:param callable: The callable to call
1212
:param args: The positional arguments for the callable
1213
:param kwargs: The keyword arguments for the callable
1215
call_warnings, result = self._capture_deprecation_warnings(callable,
1217
self.assertEqual(expected, call_warnings)
1220
def _startLogFile(self):
1221
"""Send bzr and test log messages to a temporary file.
1223
The file is removed as the test is torn down.
1225
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1226
self._log_file = os.fdopen(fileno, 'w+')
1227
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1228
self._log_file_name = name
1229
self.addCleanup(self._finishLogFile)
1231
def _finishLogFile(self):
1232
"""Finished with the log file.
1234
Close the file and delete it, unless setKeepLogfile was called.
1236
if self._log_file is None:
1238
bzrlib.trace.pop_log_file(self._log_memento)
1239
self._log_file.close()
1240
self._log_file = None
1241
if not self._keep_log_file:
1242
os.remove(self._log_file_name)
1243
self._log_file_name = None
1245
def setKeepLogfile(self):
1246
"""Make the logfile not be deleted when _finishLogFile is called."""
1247
self._keep_log_file = True
1249
def addCleanup(self, callable, *args, **kwargs):
1250
"""Arrange to run a callable when this case is torn down.
1252
Callables are run in the reverse of the order they are registered,
1253
ie last-in first-out.
1255
self._cleanups.append((callable, args, kwargs))
1257
def _cleanEnvironment(self):
1259
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1260
'HOME': os.getcwd(),
1261
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1262
# tests do check our impls match APPDATA
1263
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1267
'BZREMAIL': None, # may still be present in the environment
1269
'BZR_PROGRESS_BAR': None,
1271
'BZR_PLUGIN_PATH': None,
1273
'SSH_AUTH_SOCK': None,
1277
'https_proxy': None,
1278
'HTTPS_PROXY': None,
1283
# Nobody cares about these ones AFAIK. So far at
1284
# least. If you do (care), please update this comment
1288
'BZR_REMOTE_PATH': None,
1291
self.addCleanup(self._restoreEnvironment)
1292
for name, value in new_env.iteritems():
1293
self._captureVar(name, value)
1295
def _captureVar(self, name, newvalue):
1296
"""Set an environment variable, and reset it when finished."""
1297
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1299
def _restore_debug_flags(self):
1300
debug.debug_flags.clear()
1301
debug.debug_flags.update(self._preserved_debug_flags)
1303
def _restoreEnvironment(self):
1304
for name, value in self.__old_env.iteritems():
1305
osutils.set_or_unset_env(name, value)
1307
def _restoreHooks(self):
1308
for klass, (name, hooks) in self._preserved_hooks.items():
1309
setattr(klass, name, hooks)
1311
def knownFailure(self, reason):
1312
"""This test has failed for some known reason."""
1313
raise KnownFailure(reason)
1315
def _do_skip(self, result, reason):
1316
addSkip = getattr(result, 'addSkip', None)
1317
if not callable(addSkip):
1318
result.addError(self, self.exc_info())
1320
addSkip(self, reason)
1322
def run(self, result=None):
1323
if result is None: result = self.defaultTestResult()
1324
for feature in getattr(self, '_test_needs_features', []):
1325
if not feature.available():
1326
result.startTest(self)
1327
if getattr(result, 'addNotSupported', None):
1328
result.addNotSupported(self, feature)
1330
result.addSuccess(self)
1331
result.stopTest(self)
1335
result.startTest(self)
1336
absent_attr = object()
1338
method_name = getattr(self, '_testMethodName', absent_attr)
1339
if method_name is absent_attr:
1341
method_name = getattr(self, '_TestCase__testMethodName')
1342
testMethod = getattr(self, method_name)
1346
if not self._bzr_test_setUp_run:
1348
"test setUp did not invoke "
1349
"bzrlib.tests.TestCase's setUp")
1350
except KeyboardInterrupt:
1352
except TestSkipped, e:
1353
self._do_skip(result, e.args[0])
1357
result.addError(self, self.exc_info())
1364
except self.failureException:
1365
result.addFailure(self, self.exc_info())
1366
except TestSkipped, e:
1368
reason = "No reason given."
1371
self._do_skip(result, reason)
1372
except KeyboardInterrupt:
1375
result.addError(self, self.exc_info())
1379
if not self._bzr_test_tearDown_run:
1381
"test tearDown did not invoke "
1382
"bzrlib.tests.TestCase's tearDown")
1383
except KeyboardInterrupt:
1386
result.addError(self, self.exc_info())
1388
if ok: result.addSuccess(self)
1390
result.stopTest(self)
1392
except TestNotApplicable:
1393
# Not moved from the result [yet].
1395
except KeyboardInterrupt:
1399
absent_attr = object()
1400
for attr_name in self.attrs_to_keep:
1401
attr = getattr(self, attr_name, absent_attr)
1402
if attr is not absent_attr:
1403
saved_attrs[attr_name] = attr
1404
self.__dict__ = saved_attrs
1407
self._bzr_test_tearDown_run = True
1409
self._log_contents = ''
1410
unittest.TestCase.tearDown(self)
1412
def time(self, callable, *args, **kwargs):
1413
"""Run callable and accrue the time it takes to the benchmark time.
1415
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1416
this will cause lsprofile statistics to be gathered and stored in
1419
if self._benchtime is None:
1423
if not self._gather_lsprof_in_benchmarks:
1424
return callable(*args, **kwargs)
1426
# record this benchmark
1427
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1429
self._benchcalls.append(((callable, args, kwargs), stats))
1432
self._benchtime += time.time() - start
1434
def _runCleanups(self):
1435
"""Run registered cleanup functions.
1437
This should only be called from TestCase.tearDown.
1439
# TODO: Perhaps this should keep running cleanups even if
1440
# one of them fails?
1442
# Actually pop the cleanups from the list so tearDown running
1443
# twice is safe (this happens for skipped tests).
1444
while self._cleanups:
1445
cleanup, args, kwargs = self._cleanups.pop()
1446
cleanup(*args, **kwargs)
1448
def log(self, *args):
1451
def _get_log(self, keep_log_file=False):
1452
"""Get the log from bzrlib.trace calls from this test.
1454
:param keep_log_file: When True, if the log is still a file on disk
1455
leave it as a file on disk. When False, if the log is still a file
1456
on disk, the log file is deleted and the log preserved as
1458
:return: A string containing the log.
1460
# flush the log file, to get all content
1462
if bzrlib.trace._trace_file:
1463
bzrlib.trace._trace_file.flush()
1464
if self._log_contents:
1465
# XXX: this can hardly contain the content flushed above --vila
1467
return self._log_contents
1468
if self._log_file_name is not None:
1469
logfile = open(self._log_file_name)
1471
log_contents = logfile.read()
1474
if not keep_log_file:
1475
self._log_contents = log_contents
1477
os.remove(self._log_file_name)
1479
if sys.platform == 'win32' and e.errno == errno.EACCES:
1480
sys.stderr.write(('Unable to delete log file '
1481
' %r\n' % self._log_file_name))
1486
return "DELETED log file to reduce memory footprint"
1488
def requireFeature(self, feature):
1489
"""This test requires a specific feature is available.
1491
:raises UnavailableFeature: When feature is not available.
1493
if not feature.available():
1494
raise UnavailableFeature(feature)
1496
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1498
"""Run bazaar command line, splitting up a string command line."""
1499
if isinstance(args, basestring):
1500
# shlex don't understand unicode strings,
1501
# so args should be plain string (bialix 20070906)
1502
args = list(shlex.split(str(args)))
1503
return self._run_bzr_core(args, retcode=retcode,
1504
encoding=encoding, stdin=stdin, working_dir=working_dir,
1507
def _run_bzr_core(self, args, retcode, encoding, stdin,
1509
if encoding is None:
1510
encoding = osutils.get_user_encoding()
1511
stdout = StringIOWrapper()
1512
stderr = StringIOWrapper()
1513
stdout.encoding = encoding
1514
stderr.encoding = encoding
1516
self.log('run bzr: %r', args)
1517
# FIXME: don't call into logging here
1518
handler = logging.StreamHandler(stderr)
1519
handler.setLevel(logging.INFO)
1520
logger = logging.getLogger('')
1521
logger.addHandler(handler)
1522
old_ui_factory = ui.ui_factory
1523
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1526
if working_dir is not None:
1527
cwd = osutils.getcwd()
1528
os.chdir(working_dir)
1531
result = self.apply_redirected(ui.ui_factory.stdin,
1533
bzrlib.commands.run_bzr_catch_user_errors,
1536
logger.removeHandler(handler)
1537
ui.ui_factory = old_ui_factory
1541
out = stdout.getvalue()
1542
err = stderr.getvalue()
1544
self.log('output:\n%r', out)
1546
self.log('errors:\n%r', err)
1547
if retcode is not None:
1548
self.assertEquals(retcode, result,
1549
message='Unexpected return code')
1552
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1553
working_dir=None, error_regexes=[], output_encoding=None):
1554
"""Invoke bzr, as if it were run from the command line.
1556
The argument list should not include the bzr program name - the
1557
first argument is normally the bzr command. Arguments may be
1558
passed in three ways:
1560
1- A list of strings, eg ["commit", "a"]. This is recommended
1561
when the command contains whitespace or metacharacters, or
1562
is built up at run time.
1564
2- A single string, eg "add a". This is the most convenient
1565
for hardcoded commands.
1567
This runs bzr through the interface that catches and reports
1568
errors, and with logging set to something approximating the
1569
default, so that error reporting can be checked.
1571
This should be the main method for tests that want to exercise the
1572
overall behavior of the bzr application (rather than a unit test
1573
or a functional test of the library.)
1575
This sends the stdout/stderr results into the test's log,
1576
where it may be useful for debugging. See also run_captured.
1578
:keyword stdin: A string to be used as stdin for the command.
1579
:keyword retcode: The status code the command should return;
1581
:keyword working_dir: The directory to run the command in
1582
:keyword error_regexes: A list of expected error messages. If
1583
specified they must be seen in the error output of the command.
1585
out, err = self._run_bzr_autosplit(
1590
working_dir=working_dir,
1592
for regex in error_regexes:
1593
self.assertContainsRe(err, regex)
1596
def run_bzr_error(self, error_regexes, *args, **kwargs):
1597
"""Run bzr, and check that stderr contains the supplied regexes
1599
:param error_regexes: Sequence of regular expressions which
1600
must each be found in the error output. The relative ordering
1602
:param args: command-line arguments for bzr
1603
:param kwargs: Keyword arguments which are interpreted by run_bzr
1604
This function changes the default value of retcode to be 3,
1605
since in most cases this is run when you expect bzr to fail.
1607
:return: (out, err) The actual output of running the command (in case
1608
you want to do more inspection)
1612
# Make sure that commit is failing because there is nothing to do
1613
self.run_bzr_error(['no changes to commit'],
1614
['commit', '-m', 'my commit comment'])
1615
# Make sure --strict is handling an unknown file, rather than
1616
# giving us the 'nothing to do' error
1617
self.build_tree(['unknown'])
1618
self.run_bzr_error(['Commit refused because there are unknown files'],
1619
['commit', --strict', '-m', 'my commit comment'])
1621
kwargs.setdefault('retcode', 3)
1622
kwargs['error_regexes'] = error_regexes
1623
out, err = self.run_bzr(*args, **kwargs)
1626
def run_bzr_subprocess(self, *args, **kwargs):
1627
"""Run bzr in a subprocess for testing.
1629
This starts a new Python interpreter and runs bzr in there.
1630
This should only be used for tests that have a justifiable need for
1631
this isolation: e.g. they are testing startup time, or signal
1632
handling, or early startup code, etc. Subprocess code can't be
1633
profiled or debugged so easily.
1635
:keyword retcode: The status code that is expected. Defaults to 0. If
1636
None is supplied, the status code is not checked.
1637
:keyword env_changes: A dictionary which lists changes to environment
1638
variables. A value of None will unset the env variable.
1639
The values must be strings. The change will only occur in the
1640
child, so you don't need to fix the environment after running.
1641
:keyword universal_newlines: Convert CRLF => LF
1642
:keyword allow_plugins: By default the subprocess is run with
1643
--no-plugins to ensure test reproducibility. Also, it is possible
1644
for system-wide plugins to create unexpected output on stderr,
1645
which can cause unnecessary test failures.
1647
env_changes = kwargs.get('env_changes', {})
1648
working_dir = kwargs.get('working_dir', None)
1649
allow_plugins = kwargs.get('allow_plugins', False)
1651
if isinstance(args[0], list):
1653
elif isinstance(args[0], basestring):
1654
args = list(shlex.split(args[0]))
1656
raise ValueError("passing varargs to run_bzr_subprocess")
1657
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1658
working_dir=working_dir,
1659
allow_plugins=allow_plugins)
1660
# We distinguish between retcode=None and retcode not passed.
1661
supplied_retcode = kwargs.get('retcode', 0)
1662
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1663
universal_newlines=kwargs.get('universal_newlines', False),
1666
def start_bzr_subprocess(self, process_args, env_changes=None,
1667
skip_if_plan_to_signal=False,
1669
allow_plugins=False):
1670
"""Start bzr in a subprocess for testing.
1672
This starts a new Python interpreter and runs bzr in there.
1673
This should only be used for tests that have a justifiable need for
1674
this isolation: e.g. they are testing startup time, or signal
1675
handling, or early startup code, etc. Subprocess code can't be
1676
profiled or debugged so easily.
1678
:param process_args: a list of arguments to pass to the bzr executable,
1679
for example ``['--version']``.
1680
:param env_changes: A dictionary which lists changes to environment
1681
variables. A value of None will unset the env variable.
1682
The values must be strings. The change will only occur in the
1683
child, so you don't need to fix the environment after running.
1684
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1686
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1688
:returns: Popen object for the started process.
1690
if skip_if_plan_to_signal:
1691
if not getattr(os, 'kill', None):
1692
raise TestSkipped("os.kill not available.")
1694
if env_changes is None:
1698
def cleanup_environment():
1699
for env_var, value in env_changes.iteritems():
1700
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1702
def restore_environment():
1703
for env_var, value in old_env.iteritems():
1704
osutils.set_or_unset_env(env_var, value)
1706
bzr_path = self.get_bzr_path()
1709
if working_dir is not None:
1710
cwd = osutils.getcwd()
1711
os.chdir(working_dir)
1714
# win32 subprocess doesn't support preexec_fn
1715
# so we will avoid using it on all platforms, just to
1716
# make sure the code path is used, and we don't break on win32
1717
cleanup_environment()
1718
command = [sys.executable]
1719
# frozen executables don't need the path to bzr
1720
if getattr(sys, "frozen", None) is None:
1721
command.append(bzr_path)
1722
if not allow_plugins:
1723
command.append('--no-plugins')
1724
command.extend(process_args)
1725
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1727
restore_environment()
1733
def _popen(self, *args, **kwargs):
1734
"""Place a call to Popen.
1736
Allows tests to override this method to intercept the calls made to
1737
Popen for introspection.
1739
return Popen(*args, **kwargs)
1741
def get_bzr_path(self):
1742
"""Return the path of the 'bzr' executable for this test suite."""
1743
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1744
if not os.path.isfile(bzr_path):
1745
# We are probably installed. Assume sys.argv is the right file
1746
bzr_path = sys.argv[0]
1749
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1750
universal_newlines=False, process_args=None):
1751
"""Finish the execution of process.
1753
:param process: the Popen object returned from start_bzr_subprocess.
1754
:param retcode: The status code that is expected. Defaults to 0. If
1755
None is supplied, the status code is not checked.
1756
:param send_signal: an optional signal to send to the process.
1757
:param universal_newlines: Convert CRLF => LF
1758
:returns: (stdout, stderr)
1760
if send_signal is not None:
1761
os.kill(process.pid, send_signal)
1762
out, err = process.communicate()
1764
if universal_newlines:
1765
out = out.replace('\r\n', '\n')
1766
err = err.replace('\r\n', '\n')
1768
if retcode is not None and retcode != process.returncode:
1769
if process_args is None:
1770
process_args = "(unknown args)"
1771
mutter('Output of bzr %s:\n%s', process_args, out)
1772
mutter('Error for bzr %s:\n%s', process_args, err)
1773
self.fail('Command bzr %s failed with retcode %s != %s'
1774
% (process_args, retcode, process.returncode))
1777
def check_inventory_shape(self, inv, shape):
1778
"""Compare an inventory to a list of expected names.
1780
Fail if they are not precisely equal.
1783
shape = list(shape) # copy
1784
for path, ie in inv.entries():
1785
name = path.replace('\\', '/')
1786
if ie.kind == 'directory':
1793
self.fail("expected paths not found in inventory: %r" % shape)
1795
self.fail("unexpected paths found in inventory: %r" % extras)
1797
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1798
a_callable=None, *args, **kwargs):
1799
"""Call callable with redirected std io pipes.
1801
Returns the return code."""
1802
if not callable(a_callable):
1803
raise ValueError("a_callable must be callable.")
1805
stdin = StringIO("")
1807
if getattr(self, "_log_file", None) is not None:
1808
stdout = self._log_file
1812
if getattr(self, "_log_file", None is not None):
1813
stderr = self._log_file
1816
real_stdin = sys.stdin
1817
real_stdout = sys.stdout
1818
real_stderr = sys.stderr
1823
return a_callable(*args, **kwargs)
1825
sys.stdout = real_stdout
1826
sys.stderr = real_stderr
1827
sys.stdin = real_stdin
1829
def reduceLockdirTimeout(self):
1830
"""Reduce the default lock timeout for the duration of the test, so that
1831
if LockContention occurs during a test, it does so quickly.
1833
Tests that expect to provoke LockContention errors should call this.
1835
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1837
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1838
self.addCleanup(resetTimeout)
1839
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1841
def make_utf8_encoded_stringio(self, encoding_type=None):
1842
"""Return a StringIOWrapper instance, that will encode Unicode
1845
if encoding_type is None:
1846
encoding_type = 'strict'
1848
output_encoding = 'utf-8'
1849
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1850
sio.encoding = output_encoding
1854
class CapturedCall(object):
1855
"""A helper for capturing smart server calls for easy debug analysis."""
1857
def __init__(self, params, prefix_length):
1858
"""Capture the call with params and skip prefix_length stack frames."""
1861
# The last 5 frames are the __init__, the hook frame, and 3 smart
1862
# client frames. Beyond this we could get more clever, but this is good
1864
stack = traceback.extract_stack()[prefix_length:-5]
1865
self.stack = ''.join(traceback.format_list(stack))
1868
return self.call.method
1871
return self.call.method
1877
class TestCaseWithMemoryTransport(TestCase):
1878
"""Common test class for tests that do not need disk resources.
1880
Tests that need disk resources should derive from TestCaseWithTransport.
1882
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1884
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1885
a directory which does not exist. This serves to help ensure test isolation
1886
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1887
must exist. However, TestCaseWithMemoryTransport does not offer local
1888
file defaults for the transport in tests, nor does it obey the command line
1889
override, so tests that accidentally write to the common directory should
1892
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1893
a .bzr directory that stops us ascending higher into the filesystem.
1899
def __init__(self, methodName='runTest'):
1900
# allow test parameterization after test construction and before test
1901
# execution. Variables that the parameterizer sets need to be
1902
# ones that are not set by setUp, or setUp will trash them.
1903
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1904
self.vfs_transport_factory = default_transport
1905
self.transport_server = None
1906
self.transport_readonly_server = None
1907
self.__vfs_server = None
1909
def get_transport(self, relpath=None):
1910
"""Return a writeable transport.
1912
This transport is for the test scratch space relative to
1915
:param relpath: a path relative to the base url.
1917
t = get_transport(self.get_url(relpath))
1918
self.assertFalse(t.is_readonly())
1921
def get_readonly_transport(self, relpath=None):
1922
"""Return a readonly transport for the test scratch space
1924
This can be used to test that operations which should only need
1925
readonly access in fact do not try to write.
1927
:param relpath: a path relative to the base url.
1929
t = get_transport(self.get_readonly_url(relpath))
1930
self.assertTrue(t.is_readonly())
1933
def create_transport_readonly_server(self):
1934
"""Create a transport server from class defined at init.
1936
This is mostly a hook for daughter classes.
1938
return self.transport_readonly_server()
1940
def get_readonly_server(self):
1941
"""Get the server instance for the readonly transport
1943
This is useful for some tests with specific servers to do diagnostics.
1945
if self.__readonly_server is None:
1946
if self.transport_readonly_server is None:
1947
# readonly decorator requested
1948
# bring up the server
1949
self.__readonly_server = ReadonlyServer()
1950
self.__readonly_server.setUp(self.get_vfs_only_server())
1952
self.__readonly_server = self.create_transport_readonly_server()
1953
self.__readonly_server.setUp(self.get_vfs_only_server())
1954
self.addCleanup(self.__readonly_server.tearDown)
1955
return self.__readonly_server
1957
def get_readonly_url(self, relpath=None):
1958
"""Get a URL for the readonly transport.
1960
This will either be backed by '.' or a decorator to the transport
1961
used by self.get_url()
1962
relpath provides for clients to get a path relative to the base url.
1963
These should only be downwards relative, not upwards.
1965
base = self.get_readonly_server().get_url()
1966
return self._adjust_url(base, relpath)
1968
def get_vfs_only_server(self):
1969
"""Get the vfs only read/write server instance.
1971
This is useful for some tests with specific servers that need
1974
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1975
is no means to override it.
1977
if self.__vfs_server is None:
1978
self.__vfs_server = MemoryServer()
1979
self.__vfs_server.setUp()
1980
self.addCleanup(self.__vfs_server.tearDown)
1981
return self.__vfs_server
1983
def get_server(self):
1984
"""Get the read/write server instance.
1986
This is useful for some tests with specific servers that need
1989
This is built from the self.transport_server factory. If that is None,
1990
then the self.get_vfs_server is returned.
1992
if self.__server is None:
1993
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1994
return self.get_vfs_only_server()
1996
# bring up a decorated means of access to the vfs only server.
1997
self.__server = self.transport_server()
1999
self.__server.setUp(self.get_vfs_only_server())
2000
except TypeError, e:
2001
# This should never happen; the try:Except here is to assist
2002
# developers having to update code rather than seeing an
2003
# uninformative TypeError.
2004
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2005
self.addCleanup(self.__server.tearDown)
2006
return self.__server
2008
def _adjust_url(self, base, relpath):
2009
"""Get a URL (or maybe a path) for the readwrite transport.
2011
This will either be backed by '.' or to an equivalent non-file based
2013
relpath provides for clients to get a path relative to the base url.
2014
These should only be downwards relative, not upwards.
2016
if relpath is not None and relpath != '.':
2017
if not base.endswith('/'):
2019
# XXX: Really base should be a url; we did after all call
2020
# get_url()! But sometimes it's just a path (from
2021
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2022
# to a non-escaped local path.
2023
if base.startswith('./') or base.startswith('/'):
2026
base += urlutils.escape(relpath)
2029
def get_url(self, relpath=None):
2030
"""Get a URL (or maybe a path) for the readwrite transport.
2032
This will either be backed by '.' or to an equivalent non-file based
2034
relpath provides for clients to get a path relative to the base url.
2035
These should only be downwards relative, not upwards.
2037
base = self.get_server().get_url()
2038
return self._adjust_url(base, relpath)
2040
def get_vfs_only_url(self, relpath=None):
2041
"""Get a URL (or maybe a path for the plain old vfs transport.
2043
This will never be a smart protocol. It always has all the
2044
capabilities of the local filesystem, but it might actually be a
2045
MemoryTransport or some other similar virtual filesystem.
2047
This is the backing transport (if any) of the server returned by
2048
get_url and get_readonly_url.
2050
:param relpath: provides for clients to get a path relative to the base
2051
url. These should only be downwards relative, not upwards.
2054
base = self.get_vfs_only_server().get_url()
2055
return self._adjust_url(base, relpath)
2057
def _create_safety_net(self):
2058
"""Make a fake bzr directory.
2060
This prevents any tests propagating up onto the TEST_ROOT directory's
2063
root = TestCaseWithMemoryTransport.TEST_ROOT
2064
bzrdir.BzrDir.create_standalone_workingtree(root)
2066
def _check_safety_net(self):
2067
"""Check that the safety .bzr directory have not been touched.
2069
_make_test_root have created a .bzr directory to prevent tests from
2070
propagating. This method ensures than a test did not leaked.
2072
root = TestCaseWithMemoryTransport.TEST_ROOT
2073
wt = workingtree.WorkingTree.open(root)
2074
last_rev = wt.last_revision()
2075
if last_rev != 'null:':
2076
# The current test have modified the /bzr directory, we need to
2077
# recreate a new one or all the followng tests will fail.
2078
# If you need to inspect its content uncomment the following line
2079
# import pdb; pdb.set_trace()
2080
_rmtree_temp_dir(root + '/.bzr')
2081
self._create_safety_net()
2082
raise AssertionError('%s/.bzr should not be modified' % root)
2084
def _make_test_root(self):
2085
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2086
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2087
TestCaseWithMemoryTransport.TEST_ROOT = root
2089
self._create_safety_net()
2091
# The same directory is used by all tests, and we're not
2092
# specifically told when all tests are finished. This will do.
2093
atexit.register(_rmtree_temp_dir, root)
2095
self.addCleanup(self._check_safety_net)
2097
def makeAndChdirToTestDir(self):
2098
"""Create a temporary directories for this one test.
2100
This must set self.test_home_dir and self.test_dir and chdir to
2103
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2105
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2106
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2107
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2109
def make_branch(self, relpath, format=None):
2110
"""Create a branch on the transport at relpath."""
2111
repo = self.make_repository(relpath, format=format)
2112
return repo.bzrdir.create_branch()
2114
def make_bzrdir(self, relpath, format=None):
2116
# might be a relative or absolute path
2117
maybe_a_url = self.get_url(relpath)
2118
segments = maybe_a_url.rsplit('/', 1)
2119
t = get_transport(maybe_a_url)
2120
if len(segments) > 1 and segments[-1] not in ('', '.'):
2124
if isinstance(format, basestring):
2125
format = bzrdir.format_registry.make_bzrdir(format)
2126
return format.initialize_on_transport(t)
2127
except errors.UninitializableFormat:
2128
raise TestSkipped("Format %s is not initializable." % format)
2130
def make_repository(self, relpath, shared=False, format=None):
2131
"""Create a repository on our default transport at relpath.
2133
Note that relpath must be a relative path, not a full url.
2135
# FIXME: If you create a remoterepository this returns the underlying
2136
# real format, which is incorrect. Actually we should make sure that
2137
# RemoteBzrDir returns a RemoteRepository.
2138
# maybe mbp 20070410
2139
made_control = self.make_bzrdir(relpath, format=format)
2140
return made_control.create_repository(shared=shared)
2142
def make_smart_server(self, path):
2143
smart_server = server.SmartTCPServer_for_testing()
2144
smart_server.setUp(self.get_server())
2145
remote_transport = get_transport(smart_server.get_url()).clone(path)
2146
self.addCleanup(smart_server.tearDown)
2147
return remote_transport
2149
def make_branch_and_memory_tree(self, relpath, format=None):
2150
"""Create a branch on the default transport and a MemoryTree for it."""
2151
b = self.make_branch(relpath, format=format)
2152
return memorytree.MemoryTree.create_on_branch(b)
2154
def make_branch_builder(self, relpath, format=None):
2155
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2158
def overrideEnvironmentForTesting(self):
2159
os.environ['HOME'] = self.test_home_dir
2160
os.environ['BZR_HOME'] = self.test_home_dir
2163
super(TestCaseWithMemoryTransport, self).setUp()
2164
self._make_test_root()
2165
_currentdir = os.getcwdu()
2166
def _leaveDirectory():
2167
os.chdir(_currentdir)
2168
self.addCleanup(_leaveDirectory)
2169
self.makeAndChdirToTestDir()
2170
self.overrideEnvironmentForTesting()
2171
self.__readonly_server = None
2172
self.__server = None
2173
self.reduceLockdirTimeout()
2175
def setup_smart_server_with_call_log(self):
2176
"""Sets up a smart server as the transport server with a call log."""
2177
self.transport_server = server.SmartTCPServer_for_testing
2178
self.hpss_calls = []
2180
# Skip the current stack down to the caller of
2181
# setup_smart_server_with_call_log
2182
prefix_length = len(traceback.extract_stack()) - 2
2183
def capture_hpss_call(params):
2184
self.hpss_calls.append(
2185
CapturedCall(params, prefix_length))
2186
client._SmartClient.hooks.install_named_hook(
2187
'call', capture_hpss_call, None)
2189
def reset_smart_call_log(self):
2190
self.hpss_calls = []
2193
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2194
"""Derived class that runs a test within a temporary directory.
2196
This is useful for tests that need to create a branch, etc.
2198
The directory is created in a slightly complex way: for each
2199
Python invocation, a new temporary top-level directory is created.
2200
All test cases create their own directory within that. If the
2201
tests complete successfully, the directory is removed.
2203
:ivar test_base_dir: The path of the top-level directory for this
2204
test, which contains a home directory and a work directory.
2206
:ivar test_home_dir: An initially empty directory under test_base_dir
2207
which is used as $HOME for this test.
2209
:ivar test_dir: A directory under test_base_dir used as the current
2210
directory when the test proper is run.
2213
OVERRIDE_PYTHON = 'python'
2215
def check_file_contents(self, filename, expect):
2216
self.log("check contents of file %s" % filename)
2217
contents = file(filename, 'r').read()
2218
if contents != expect:
2219
self.log("expected: %r" % expect)
2220
self.log("actually: %r" % contents)
2221
self.fail("contents of %s not as expected" % filename)
2223
def _getTestDirPrefix(self):
2224
# create a directory within the top level test directory
2225
if sys.platform == 'win32':
2226
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2227
# windows is likely to have path-length limits so use a short name
2228
name_prefix = name_prefix[-30:]
2230
name_prefix = re.sub('[/]', '_', self.id())
2233
def makeAndChdirToTestDir(self):
2234
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2236
For TestCaseInTempDir we create a temporary directory based on the test
2237
name and then create two subdirs - test and home under it.
2239
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2240
self._getTestDirPrefix())
2242
for i in range(100):
2243
if os.path.exists(name):
2244
name = name_prefix + '_' + str(i)
2248
# now create test and home directories within this dir
2249
self.test_base_dir = name
2250
self.test_home_dir = self.test_base_dir + '/home'
2251
os.mkdir(self.test_home_dir)
2252
self.test_dir = self.test_base_dir + '/work'
2253
os.mkdir(self.test_dir)
2254
os.chdir(self.test_dir)
2255
# put name of test inside
2256
f = file(self.test_base_dir + '/name', 'w')
2261
self.addCleanup(self.deleteTestDir)
2263
def deleteTestDir(self):
2264
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2265
_rmtree_temp_dir(self.test_base_dir)
2267
def build_tree(self, shape, line_endings='binary', transport=None):
2268
"""Build a test tree according to a pattern.
2270
shape is a sequence of file specifications. If the final
2271
character is '/', a directory is created.
2273
This assumes that all the elements in the tree being built are new.
2275
This doesn't add anything to a branch.
2277
:type shape: list or tuple.
2278
:param line_endings: Either 'binary' or 'native'
2279
in binary mode, exact contents are written in native mode, the
2280
line endings match the default platform endings.
2281
:param transport: A transport to write to, for building trees on VFS's.
2282
If the transport is readonly or None, "." is opened automatically.
2285
if type(shape) not in (list, tuple):
2286
raise AssertionError("Parameter 'shape' should be "
2287
"a list or a tuple. Got %r instead" % (shape,))
2288
# It's OK to just create them using forward slashes on windows.
2289
if transport is None or transport.is_readonly():
2290
transport = get_transport(".")
2292
self.assertIsInstance(name, basestring)
2294
transport.mkdir(urlutils.escape(name[:-1]))
2296
if line_endings == 'binary':
2298
elif line_endings == 'native':
2301
raise errors.BzrError(
2302
'Invalid line ending request %r' % line_endings)
2303
content = "contents of %s%s" % (name.encode('utf-8'), end)
2304
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2306
def build_tree_contents(self, shape):
2307
build_tree_contents(shape)
2309
def assertInWorkingTree(self, path, root_path='.', tree=None):
2310
"""Assert whether path or paths are in the WorkingTree"""
2312
tree = workingtree.WorkingTree.open(root_path)
2313
if not isinstance(path, basestring):
2315
self.assertInWorkingTree(p, tree=tree)
2317
self.assertIsNot(tree.path2id(path), None,
2318
path+' not in working tree.')
2320
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2321
"""Assert whether path or paths are not in the WorkingTree"""
2323
tree = workingtree.WorkingTree.open(root_path)
2324
if not isinstance(path, basestring):
2326
self.assertNotInWorkingTree(p,tree=tree)
2328
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2331
class TestCaseWithTransport(TestCaseInTempDir):
2332
"""A test case that provides get_url and get_readonly_url facilities.
2334
These back onto two transport servers, one for readonly access and one for
2337
If no explicit class is provided for readonly access, a
2338
ReadonlyTransportDecorator is used instead which allows the use of non disk
2339
based read write transports.
2341
If an explicit class is provided for readonly access, that server and the
2342
readwrite one must both define get_url() as resolving to os.getcwd().
2345
def get_vfs_only_server(self):
2346
"""See TestCaseWithMemoryTransport.
2348
This is useful for some tests with specific servers that need
2351
if self.__vfs_server is None:
2352
self.__vfs_server = self.vfs_transport_factory()
2353
self.__vfs_server.setUp()
2354
self.addCleanup(self.__vfs_server.tearDown)
2355
return self.__vfs_server
2357
def make_branch_and_tree(self, relpath, format=None):
2358
"""Create a branch on the transport and a tree locally.
2360
If the transport is not a LocalTransport, the Tree can't be created on
2361
the transport. In that case if the vfs_transport_factory is
2362
LocalURLServer the working tree is created in the local
2363
directory backing the transport, and the returned tree's branch and
2364
repository will also be accessed locally. Otherwise a lightweight
2365
checkout is created and returned.
2367
:param format: The BzrDirFormat.
2368
:returns: the WorkingTree.
2370
# TODO: always use the local disk path for the working tree,
2371
# this obviously requires a format that supports branch references
2372
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2374
b = self.make_branch(relpath, format=format)
2376
return b.bzrdir.create_workingtree()
2377
except errors.NotLocalUrl:
2378
# We can only make working trees locally at the moment. If the
2379
# transport can't support them, then we keep the non-disk-backed
2380
# branch and create a local checkout.
2381
if self.vfs_transport_factory is LocalURLServer:
2382
# the branch is colocated on disk, we cannot create a checkout.
2383
# hopefully callers will expect this.
2384
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2385
wt = local_controldir.create_workingtree()
2386
if wt.branch._format != b._format:
2388
# Make sure that assigning to wt._branch fixes wt.branch,
2389
# in case the implementation details of workingtree objects
2391
self.assertIs(b, wt.branch)
2394
return b.create_checkout(relpath, lightweight=True)
2396
def assertIsDirectory(self, relpath, transport):
2397
"""Assert that relpath within transport is a directory.
2399
This may not be possible on all transports; in that case it propagates
2400
a TransportNotPossible.
2403
mode = transport.stat(relpath).st_mode
2404
except errors.NoSuchFile:
2405
self.fail("path %s is not a directory; no such file"
2407
if not stat.S_ISDIR(mode):
2408
self.fail("path %s is not a directory; has mode %#o"
2411
def assertTreesEqual(self, left, right):
2412
"""Check that left and right have the same content and properties."""
2413
# we use a tree delta to check for equality of the content, and we
2414
# manually check for equality of other things such as the parents list.
2415
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2416
differences = left.changes_from(right)
2417
self.assertFalse(differences.has_changed(),
2418
"Trees %r and %r are different: %r" % (left, right, differences))
2421
super(TestCaseWithTransport, self).setUp()
2422
self.__vfs_server = None
2425
class ChrootedTestCase(TestCaseWithTransport):
2426
"""A support class that provides readonly urls outside the local namespace.
2428
This is done by checking if self.transport_server is a MemoryServer. if it
2429
is then we are chrooted already, if it is not then an HttpServer is used
2432
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2433
be used without needed to redo it when a different
2434
subclass is in use ?
2438
super(ChrootedTestCase, self).setUp()
2439
if not self.vfs_transport_factory == MemoryServer:
2440
self.transport_readonly_server = HttpServer
2443
def condition_id_re(pattern):
2444
"""Create a condition filter which performs a re check on a test's id.
2446
:param pattern: A regular expression string.
2447
:return: A callable that returns True if the re matches.
2449
filter_re = osutils.re_compile_checked(pattern, 0,
2451
def condition(test):
2453
return filter_re.search(test_id)
2457
def condition_isinstance(klass_or_klass_list):
2458
"""Create a condition filter which returns isinstance(param, klass).
2460
:return: A callable which when called with one parameter obj return the
2461
result of isinstance(obj, klass_or_klass_list).
2464
return isinstance(obj, klass_or_klass_list)
2468
def condition_id_in_list(id_list):
2469
"""Create a condition filter which verify that test's id in a list.
2471
:param id_list: A TestIdList object.
2472
:return: A callable that returns True if the test's id appears in the list.
2474
def condition(test):
2475
return id_list.includes(test.id())
2479
def condition_id_startswith(starts):
2480
"""Create a condition filter verifying that test's id starts with a string.
2482
:param starts: A list of string.
2483
:return: A callable that returns True if the test's id starts with one of
2486
def condition(test):
2487
for start in starts:
2488
if test.id().startswith(start):
2494
def exclude_tests_by_condition(suite, condition):
2495
"""Create a test suite which excludes some tests from suite.
2497
:param suite: The suite to get tests from.
2498
:param condition: A callable whose result evaluates True when called with a
2499
test case which should be excluded from the result.
2500
:return: A suite which contains the tests found in suite that fail
2504
for test in iter_suite_tests(suite):
2505
if not condition(test):
2507
return TestUtil.TestSuite(result)
2510
def filter_suite_by_condition(suite, condition):
2511
"""Create a test suite by filtering another one.
2513
:param suite: The source suite.
2514
:param condition: A callable whose result evaluates True when called with a
2515
test case which should be included in the result.
2516
:return: A suite which contains the tests found in suite that pass
2520
for test in iter_suite_tests(suite):
2523
return TestUtil.TestSuite(result)
2526
def filter_suite_by_re(suite, pattern):
2527
"""Create a test suite by filtering another one.
2529
:param suite: the source suite
2530
:param pattern: pattern that names must match
2531
:returns: the newly created suite
2533
condition = condition_id_re(pattern)
2534
result_suite = filter_suite_by_condition(suite, condition)
2538
def filter_suite_by_id_list(suite, test_id_list):
2539
"""Create a test suite by filtering another one.
2541
:param suite: The source suite.
2542
:param test_id_list: A list of the test ids to keep as strings.
2543
:returns: the newly created suite
2545
condition = condition_id_in_list(test_id_list)
2546
result_suite = filter_suite_by_condition(suite, condition)
2550
def filter_suite_by_id_startswith(suite, start):
2551
"""Create a test suite by filtering another one.
2553
:param suite: The source suite.
2554
:param start: A list of string the test id must start with one of.
2555
:returns: the newly created suite
2557
condition = condition_id_startswith(start)
2558
result_suite = filter_suite_by_condition(suite, condition)
2562
def exclude_tests_by_re(suite, pattern):
2563
"""Create a test suite which excludes some tests from suite.
2565
:param suite: The suite to get tests from.
2566
:param pattern: A regular expression string. Test ids that match this
2567
pattern will be excluded from the result.
2568
:return: A TestSuite that contains all the tests from suite without the
2569
tests that matched pattern. The order of tests is the same as it was in
2572
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2575
def preserve_input(something):
2576
"""A helper for performing test suite transformation chains.
2578
:param something: Anything you want to preserve.
2584
def randomize_suite(suite):
2585
"""Return a new TestSuite with suite's tests in random order.
2587
The tests in the input suite are flattened into a single suite in order to
2588
accomplish this. Any nested TestSuites are removed to provide global
2591
tests = list(iter_suite_tests(suite))
2592
random.shuffle(tests)
2593
return TestUtil.TestSuite(tests)
2596
def split_suite_by_condition(suite, condition):
2597
"""Split a test suite into two by a condition.
2599
:param suite: The suite to split.
2600
:param condition: The condition to match on. Tests that match this
2601
condition are returned in the first test suite, ones that do not match
2602
are in the second suite.
2603
:return: A tuple of two test suites, where the first contains tests from
2604
suite matching the condition, and the second contains the remainder
2605
from suite. The order within each output suite is the same as it was in
2610
for test in iter_suite_tests(suite):
2612
matched.append(test)
2614
did_not_match.append(test)
2615
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2618
def split_suite_by_re(suite, pattern):
2619
"""Split a test suite into two by a regular expression.
2621
:param suite: The suite to split.
2622
:param pattern: A regular expression string. Test ids that match this
2623
pattern will be in the first test suite returned, and the others in the
2624
second test suite returned.
2625
:return: A tuple of two test suites, where the first contains tests from
2626
suite matching pattern, and the second contains the remainder from
2627
suite. The order within each output suite is the same as it was in
2630
return split_suite_by_condition(suite, condition_id_re(pattern))
2633
def run_suite(suite, name='test', verbose=False, pattern=".*",
2634
stop_on_failure=False,
2635
transport=None, lsprof_timed=None, bench_history=None,
2636
matching_tests_first=None,
2639
exclude_pattern=None,
2642
suite_decorators=None):
2643
"""Run a test suite for bzr selftest.
2645
:param runner_class: The class of runner to use. Must support the
2646
constructor arguments passed by run_suite which are more than standard
2648
:return: A boolean indicating success.
2650
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2655
if runner_class is None:
2656
runner_class = TextTestRunner
2657
runner = runner_class(stream=sys.stdout,
2659
verbosity=verbosity,
2660
bench_history=bench_history,
2661
list_only=list_only,
2663
runner.stop_on_failure=stop_on_failure
2664
# built in decorator factories:
2666
random_order(random_seed, runner),
2667
exclude_tests(exclude_pattern),
2669
if matching_tests_first:
2670
decorators.append(tests_first(pattern))
2672
decorators.append(filter_tests(pattern))
2673
if suite_decorators:
2674
decorators.extend(suite_decorators)
2675
for decorator in decorators:
2676
suite = decorator(suite)
2677
result = runner.run(suite)
2679
return result.wasStrictlySuccessful()
2681
return result.wasSuccessful()
2684
# A registry where get() returns a suite decorator.
2685
parallel_registry = registry.Registry()
2686
def fork_decorator(suite):
2687
concurrency = local_concurrency()
2688
if concurrency == 1:
2690
from testtools import ConcurrentTestSuite
2691
return ConcurrentTestSuite(suite, fork_for_tests)
2692
parallel_registry.register('fork', fork_decorator)
2693
def subprocess_decorator(suite):
2694
concurrency = local_concurrency()
2695
if concurrency == 1:
2697
from testtools import ConcurrentTestSuite
2698
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2699
parallel_registry.register('subprocess', subprocess_decorator)
2702
def exclude_tests(exclude_pattern):
2703
"""Return a test suite decorator that excludes tests."""
2704
if exclude_pattern is None:
2705
return identity_decorator
2706
def decorator(suite):
2707
return ExcludeDecorator(suite, exclude_pattern)
2711
def filter_tests(pattern):
2713
return identity_decorator
2714
def decorator(suite):
2715
return FilterTestsDecorator(suite, pattern)
2719
def random_order(random_seed, runner):
2720
"""Return a test suite decorator factory for randomising tests order.
2722
:param random_seed: now, a string which casts to a long, or a long.
2723
:param runner: A test runner with a stream attribute to report on.
2725
if random_seed is None:
2726
return identity_decorator
2727
def decorator(suite):
2728
return RandomDecorator(suite, random_seed, runner.stream)
2732
def tests_first(pattern):
2734
return identity_decorator
2735
def decorator(suite):
2736
return TestFirstDecorator(suite, pattern)
2740
def identity_decorator(suite):
2745
class TestDecorator(TestSuite):
2746
"""A decorator for TestCase/TestSuite objects.
2748
Usually, subclasses should override __iter__(used when flattening test
2749
suites), which we do to filter, reorder, parallelise and so on, run() and
2753
def __init__(self, suite):
2754
TestSuite.__init__(self)
2757
def countTestCases(self):
2760
cases += test.countTestCases()
2767
def run(self, result):
2768
# Use iteration on self, not self._tests, to allow subclasses to hook
2771
if result.shouldStop:
2777
class ExcludeDecorator(TestDecorator):
2778
"""A decorator which excludes test matching an exclude pattern."""
2780
def __init__(self, suite, exclude_pattern):
2781
TestDecorator.__init__(self, suite)
2782
self.exclude_pattern = exclude_pattern
2783
self.excluded = False
2787
return iter(self._tests)
2788
self.excluded = True
2789
suite = exclude_tests_by_re(self, self.exclude_pattern)
2791
self.addTests(suite)
2792
return iter(self._tests)
2795
class FilterTestsDecorator(TestDecorator):
2796
"""A decorator which filters tests to those matching a pattern."""
2798
def __init__(self, suite, pattern):
2799
TestDecorator.__init__(self, suite)
2800
self.pattern = pattern
2801
self.filtered = False
2805
return iter(self._tests)
2806
self.filtered = True
2807
suite = filter_suite_by_re(self, self.pattern)
2809
self.addTests(suite)
2810
return iter(self._tests)
2813
class RandomDecorator(TestDecorator):
2814
"""A decorator which randomises the order of its tests."""
2816
def __init__(self, suite, random_seed, stream):
2817
TestDecorator.__init__(self, suite)
2818
self.random_seed = random_seed
2819
self.randomised = False
2820
self.stream = stream
2824
return iter(self._tests)
2825
self.randomised = True
2826
self.stream.writeln("Randomizing test order using seed %s\n" %
2827
(self.actual_seed()))
2828
# Initialise the random number generator.
2829
random.seed(self.actual_seed())
2830
suite = randomize_suite(self)
2832
self.addTests(suite)
2833
return iter(self._tests)
2835
def actual_seed(self):
2836
if self.random_seed == "now":
2837
# We convert the seed to a long to make it reuseable across
2838
# invocations (because the user can reenter it).
2839
self.random_seed = long(time.time())
2841
# Convert the seed to a long if we can
2843
self.random_seed = long(self.random_seed)
2846
return self.random_seed
2849
class TestFirstDecorator(TestDecorator):
2850
"""A decorator which moves named tests to the front."""
2852
def __init__(self, suite, pattern):
2853
TestDecorator.__init__(self, suite)
2854
self.pattern = pattern
2855
self.filtered = False
2859
return iter(self._tests)
2860
self.filtered = True
2861
suites = split_suite_by_re(self, self.pattern)
2863
self.addTests(suites)
2864
return iter(self._tests)
2867
def partition_tests(suite, count):
2868
"""Partition suite into count lists of tests."""
2870
tests = list(iter_suite_tests(suite))
2871
tests_per_process = int(math.ceil(float(len(tests)) / count))
2872
for block in range(count):
2873
low_test = block * tests_per_process
2874
high_test = low_test + tests_per_process
2875
process_tests = tests[low_test:high_test]
2876
result.append(process_tests)
2880
def fork_for_tests(suite):
2881
"""Take suite and start up one runner per CPU by forking()
2883
:return: An iterable of TestCase-like objects which can each have
2884
run(result) called on them to feed tests to result, and
2885
cleanup() called on them to stop them/kill children/end threads.
2887
concurrency = local_concurrency()
2889
from subunit import TestProtocolClient, ProtocolTestCase
2890
class TestInOtherProcess(ProtocolTestCase):
2891
# Should be in subunit, I think. RBC.
2892
def __init__(self, stream, pid):
2893
ProtocolTestCase.__init__(self, stream)
2896
def run(self, result):
2898
ProtocolTestCase.run(self, result)
2900
os.waitpid(self.pid, os.WNOHANG)
2901
# print "pid %d finished" % finished_process
2903
test_blocks = partition_tests(suite, concurrency)
2904
for process_tests in test_blocks:
2905
process_suite = TestSuite()
2906
process_suite.addTests(process_tests)
2907
c2pread, c2pwrite = os.pipe()
2912
# Leave stderr and stdout open so we can see test noise
2913
# Close stdin so that the child goes away if it decides to
2914
# read from stdin (otherwise its a roulette to see what
2915
# child actually gets keystrokes for pdb etc.
2918
stream = os.fdopen(c2pwrite, 'wb', 0)
2919
subunit_result = TestProtocolClient(stream)
2920
process_suite.run(subunit_result)
2925
stream = os.fdopen(c2pread, 'rb', 1)
2926
test = TestInOtherProcess(stream, pid)
2931
def reinvoke_for_tests(suite):
2932
"""Take suite and start up one runner per CPU using subprocess().
2934
:return: An iterable of TestCase-like objects which can each have
2935
run(result) called on them to feed tests to result, and
2936
cleanup() called on them to stop them/kill children/end threads.
2938
concurrency = local_concurrency()
2940
from subunit import TestProtocolClient, ProtocolTestCase
2941
class TestInSubprocess(ProtocolTestCase):
2942
def __init__(self, process, name):
2943
ProtocolTestCase.__init__(self, process.stdout)
2944
self.process = process
2945
self.process.stdin.close()
2948
def run(self, result):
2950
ProtocolTestCase.run(self, result)
2953
os.unlink(self.name)
2954
# print "pid %d finished" % finished_process
2955
test_blocks = partition_tests(suite, concurrency)
2956
for process_tests in test_blocks:
2957
# ugly; currently reimplement rather than reuses TestCase methods.
2958
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2959
if not os.path.isfile(bzr_path):
2960
# We are probably installed. Assume sys.argv is the right file
2961
bzr_path = sys.argv[0]
2962
fd, test_list_file_name = tempfile.mkstemp()
2963
test_list_file = os.fdopen(fd, 'wb', 1)
2964
for test in process_tests:
2965
test_list_file.write(test.id() + '\n')
2966
test_list_file.close()
2968
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
2970
if '--no-plugins' in sys.argv:
2971
argv.append('--no-plugins')
2972
# stderr=STDOUT would be ideal, but until we prevent noise on
2973
# stderr it can interrupt the subunit protocol.
2974
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
2976
test = TestInSubprocess(process, test_list_file_name)
2979
os.unlink(test_list_file_name)
2984
def cpucount(content):
2985
lines = content.splitlines()
2986
prefix = 'processor'
2988
if line.startswith(prefix):
2989
concurrency = int(line[line.find(':')+1:]) + 1
2993
def local_concurrency():
2995
content = file('/proc/cpuinfo', 'rb').read()
2996
concurrency = cpucount(content)
2997
except Exception, e:
3002
class BZRTransformingResult(unittest.TestResult):
3004
def __init__(self, target):
3005
unittest.TestResult.__init__(self)
3006
self.result = target
3008
def startTest(self, test):
3009
self.result.startTest(test)
3011
def stopTest(self, test):
3012
self.result.stopTest(test)
3014
def addError(self, test, err):
3015
feature = self._error_looks_like('UnavailableFeature: ', err)
3016
if feature is not None:
3017
self.result.addNotSupported(test, feature)
3019
self.result.addError(test, err)
3021
def addFailure(self, test, err):
3022
known = self._error_looks_like('KnownFailure: ', err)
3023
if known is not None:
3024
self.result._addKnownFailure(test, [KnownFailure,
3025
KnownFailure(known), None])
3027
self.result.addFailure(test, err)
3029
def addSkip(self, test, reason):
3030
self.result.addSkip(test, reason)
3032
def addSuccess(self, test):
3033
self.result.addSuccess(test)
3035
def _error_looks_like(self, prefix, err):
3036
"""Deserialize exception and returns the stringify value."""
3040
if isinstance(exc, subunit.RemoteException):
3041
# stringify the exception gives access to the remote traceback
3042
# We search the last line for 'prefix'
3043
lines = str(exc).split('\n')
3045
last = lines[-2] # -1 is empty, final \n
3048
if last.startswith(prefix):
3049
value = last[len(prefix):]
3053
# Controlled by "bzr selftest -E=..." option
3054
selftest_debug_flags = set()
3057
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3059
test_suite_factory=None,
3062
matching_tests_first=None,
3065
exclude_pattern=None,
3071
suite_decorators=None,
3073
"""Run the whole test suite under the enhanced runner"""
3074
# XXX: Very ugly way to do this...
3075
# Disable warning about old formats because we don't want it to disturb
3076
# any blackbox tests.
3077
from bzrlib import repository
3078
repository._deprecation_warning_done = True
3080
global default_transport
3081
if transport is None:
3082
transport = default_transport
3083
old_transport = default_transport
3084
default_transport = transport
3085
global selftest_debug_flags
3086
old_debug_flags = selftest_debug_flags
3087
if debug_flags is not None:
3088
selftest_debug_flags = set(debug_flags)
3090
if load_list is None:
3093
keep_only = load_test_id_list(load_list)
3094
if test_suite_factory is None:
3095
suite = test_suite(keep_only, starting_with)
3097
suite = test_suite_factory()
3098
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3099
stop_on_failure=stop_on_failure,
3100
transport=transport,
3101
lsprof_timed=lsprof_timed,
3102
bench_history=bench_history,
3103
matching_tests_first=matching_tests_first,
3104
list_only=list_only,
3105
random_seed=random_seed,
3106
exclude_pattern=exclude_pattern,
3108
runner_class=runner_class,
3109
suite_decorators=suite_decorators,
3112
default_transport = old_transport
3113
selftest_debug_flags = old_debug_flags
3116
def load_test_id_list(file_name):
3117
"""Load a test id list from a text file.
3119
The format is one test id by line. No special care is taken to impose
3120
strict rules, these test ids are used to filter the test suite so a test id
3121
that do not match an existing test will do no harm. This allows user to add
3122
comments, leave blank lines, etc.
3126
ftest = open(file_name, 'rt')
3128
if e.errno != errno.ENOENT:
3131
raise errors.NoSuchFile(file_name)
3133
for test_name in ftest.readlines():
3134
test_list.append(test_name.strip())
3139
def suite_matches_id_list(test_suite, id_list):
3140
"""Warns about tests not appearing or appearing more than once.
3142
:param test_suite: A TestSuite object.
3143
:param test_id_list: The list of test ids that should be found in
3146
:return: (absents, duplicates) absents is a list containing the test found
3147
in id_list but not in test_suite, duplicates is a list containing the
3148
test found multiple times in test_suite.
3150
When using a prefined test id list, it may occurs that some tests do not
3151
exist anymore or that some tests use the same id. This function warns the
3152
tester about potential problems in his workflow (test lists are volatile)
3153
or in the test suite itself (using the same id for several tests does not
3154
help to localize defects).
3156
# Build a dict counting id occurrences
3158
for test in iter_suite_tests(test_suite):
3160
tests[id] = tests.get(id, 0) + 1
3165
occurs = tests.get(id, 0)
3167
not_found.append(id)
3169
duplicates.append(id)
3171
return not_found, duplicates
3174
class TestIdList(object):
3175
"""Test id list to filter a test suite.
3177
Relying on the assumption that test ids are built as:
3178
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3179
notation, this class offers methods to :
3180
- avoid building a test suite for modules not refered to in the test list,
3181
- keep only the tests listed from the module test suite.
3184
def __init__(self, test_id_list):
3185
# When a test suite needs to be filtered against us we compare test ids
3186
# for equality, so a simple dict offers a quick and simple solution.
3187
self.tests = dict().fromkeys(test_id_list, True)
3189
# While unittest.TestCase have ids like:
3190
# <module>.<class>.<method>[(<param+)],
3191
# doctest.DocTestCase can have ids like:
3194
# <module>.<function>
3195
# <module>.<class>.<method>
3197
# Since we can't predict a test class from its name only, we settle on
3198
# a simple constraint: a test id always begins with its module name.
3201
for test_id in test_id_list:
3202
parts = test_id.split('.')
3203
mod_name = parts.pop(0)
3204
modules[mod_name] = True
3206
mod_name += '.' + part
3207
modules[mod_name] = True
3208
self.modules = modules
3210
def refers_to(self, module_name):
3211
"""Is there tests for the module or one of its sub modules."""
3212
return self.modules.has_key(module_name)
3214
def includes(self, test_id):
3215
return self.tests.has_key(test_id)
3218
class TestPrefixAliasRegistry(registry.Registry):
3219
"""A registry for test prefix aliases.
3221
This helps implement shorcuts for the --starting-with selftest
3222
option. Overriding existing prefixes is not allowed but not fatal (a
3223
warning will be emitted).
3226
def register(self, key, obj, help=None, info=None,
3227
override_existing=False):
3228
"""See Registry.register.
3230
Trying to override an existing alias causes a warning to be emitted,
3231
not a fatal execption.
3234
super(TestPrefixAliasRegistry, self).register(
3235
key, obj, help=help, info=info, override_existing=False)
3237
actual = self.get(key)
3238
note('Test prefix alias %s is already used for %s, ignoring %s'
3239
% (key, actual, obj))
3241
def resolve_alias(self, id_start):
3242
"""Replace the alias by the prefix in the given string.
3244
Using an unknown prefix is an error to help catching typos.
3246
parts = id_start.split('.')
3248
parts[0] = self.get(parts[0])
3250
raise errors.BzrCommandError(
3251
'%s is not a known test prefix alias' % parts[0])
3252
return '.'.join(parts)
3255
test_prefix_alias_registry = TestPrefixAliasRegistry()
3256
"""Registry of test prefix aliases."""
3259
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3260
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3261
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3263
# Obvious higest levels prefixes, feel free to add your own via a plugin
3264
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3265
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3266
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3267
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3268
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3271
def test_suite(keep_only=None, starting_with=None):
3272
"""Build and return TestSuite for the whole of bzrlib.
3274
:param keep_only: A list of test ids limiting the suite returned.
3276
:param starting_with: An id limiting the suite returned to the tests
3279
This function can be replaced if you need to change the default test
3280
suite on a global basis, but it is not encouraged.
3284
'bzrlib.tests.blackbox',
3285
'bzrlib.tests.branch_implementations',
3286
'bzrlib.tests.bzrdir_implementations',
3287
'bzrlib.tests.commands',
3288
'bzrlib.tests.interrepository_implementations',
3289
'bzrlib.tests.intertree_implementations',
3290
'bzrlib.tests.inventory_implementations',
3291
'bzrlib.tests.per_interbranch',
3292
'bzrlib.tests.per_lock',
3293
'bzrlib.tests.per_repository',
3294
'bzrlib.tests.per_repository_reference',
3295
'bzrlib.tests.test__dirstate_helpers',
3296
'bzrlib.tests.test__walkdirs_win32',
3297
'bzrlib.tests.test_ancestry',
3298
'bzrlib.tests.test_annotate',
3299
'bzrlib.tests.test_api',
3300
'bzrlib.tests.test_atomicfile',
3301
'bzrlib.tests.test_bad_files',
3302
'bzrlib.tests.test_bisect_multi',
3303
'bzrlib.tests.test_branch',
3304
'bzrlib.tests.test_branchbuilder',
3305
'bzrlib.tests.test_btree_index',
3306
'bzrlib.tests.test_bugtracker',
3307
'bzrlib.tests.test_bundle',
3308
'bzrlib.tests.test_bzrdir',
3309
'bzrlib.tests.test_cache_utf8',
3310
'bzrlib.tests.test_clean_tree',
3311
'bzrlib.tests.test_chunk_writer',
3312
'bzrlib.tests.test__chunks_to_lines',
3313
'bzrlib.tests.test_commands',
3314
'bzrlib.tests.test_commit',
3315
'bzrlib.tests.test_commit_merge',
3316
'bzrlib.tests.test_config',
3317
'bzrlib.tests.test_conflicts',
3318
'bzrlib.tests.test_counted_lock',
3319
'bzrlib.tests.test_decorators',
3320
'bzrlib.tests.test_delta',
3321
'bzrlib.tests.test_debug',
3322
'bzrlib.tests.test_deprecated_graph',
3323
'bzrlib.tests.test_diff',
3324
'bzrlib.tests.test_directory_service',
3325
'bzrlib.tests.test_dirstate',
3326
'bzrlib.tests.test_email_message',
3327
'bzrlib.tests.test_errors',
3328
'bzrlib.tests.test_export',
3329
'bzrlib.tests.test_extract',
3330
'bzrlib.tests.test_fetch',
3331
'bzrlib.tests.test_fifo_cache',
3332
'bzrlib.tests.test_filters',
3333
'bzrlib.tests.test_ftp_transport',
3334
'bzrlib.tests.test_foreign',
3335
'bzrlib.tests.test_generate_docs',
3336
'bzrlib.tests.test_generate_ids',
3337
'bzrlib.tests.test_globbing',
3338
'bzrlib.tests.test_gpg',
3339
'bzrlib.tests.test_graph',
3340
'bzrlib.tests.test_hashcache',
3341
'bzrlib.tests.test_help',
3342
'bzrlib.tests.test_hooks',
3343
'bzrlib.tests.test_http',
3344
'bzrlib.tests.test_http_implementations',
3345
'bzrlib.tests.test_http_response',
3346
'bzrlib.tests.test_https_ca_bundle',
3347
'bzrlib.tests.test_identitymap',
3348
'bzrlib.tests.test_ignores',
3349
'bzrlib.tests.test_index',
3350
'bzrlib.tests.test_info',
3351
'bzrlib.tests.test_inv',
3352
'bzrlib.tests.test_knit',
3353
'bzrlib.tests.test_lazy_import',
3354
'bzrlib.tests.test_lazy_regex',
3355
'bzrlib.tests.test_lockable_files',
3356
'bzrlib.tests.test_lockdir',
3357
'bzrlib.tests.test_log',
3358
'bzrlib.tests.test_lru_cache',
3359
'bzrlib.tests.test_lsprof',
3360
'bzrlib.tests.test_mail_client',
3361
'bzrlib.tests.test_memorytree',
3362
'bzrlib.tests.test_merge',
3363
'bzrlib.tests.test_merge3',
3364
'bzrlib.tests.test_merge_core',
3365
'bzrlib.tests.test_merge_directive',
3366
'bzrlib.tests.test_missing',
3367
'bzrlib.tests.test_msgeditor',
3368
'bzrlib.tests.test_multiparent',
3369
'bzrlib.tests.test_mutabletree',
3370
'bzrlib.tests.test_nonascii',
3371
'bzrlib.tests.test_options',
3372
'bzrlib.tests.test_osutils',
3373
'bzrlib.tests.test_osutils_encodings',
3374
'bzrlib.tests.test_pack',
3375
'bzrlib.tests.test_pack_repository',
3376
'bzrlib.tests.test_patch',
3377
'bzrlib.tests.test_patches',
3378
'bzrlib.tests.test_permissions',
3379
'bzrlib.tests.test_plugins',
3380
'bzrlib.tests.test_progress',
3381
'bzrlib.tests.test_read_bundle',
3382
'bzrlib.tests.test_reconcile',
3383
'bzrlib.tests.test_reconfigure',
3384
'bzrlib.tests.test_registry',
3385
'bzrlib.tests.test_remote',
3386
'bzrlib.tests.test_rename_map',
3387
'bzrlib.tests.test_repository',
3388
'bzrlib.tests.test_revert',
3389
'bzrlib.tests.test_revision',
3390
'bzrlib.tests.test_revisionspec',
3391
'bzrlib.tests.test_revisiontree',
3392
'bzrlib.tests.test_rio',
3393
'bzrlib.tests.test_rules',
3394
'bzrlib.tests.test_sampler',
3395
'bzrlib.tests.test_selftest',
3396
'bzrlib.tests.test_setup',
3397
'bzrlib.tests.test_sftp_transport',
3398
'bzrlib.tests.test_shelf',
3399
'bzrlib.tests.test_shelf_ui',
3400
'bzrlib.tests.test_smart',
3401
'bzrlib.tests.test_smart_add',
3402
'bzrlib.tests.test_smart_request',
3403
'bzrlib.tests.test_smart_transport',
3404
'bzrlib.tests.test_smtp_connection',
3405
'bzrlib.tests.test_source',
3406
'bzrlib.tests.test_ssh_transport',
3407
'bzrlib.tests.test_status',
3408
'bzrlib.tests.test_store',
3409
'bzrlib.tests.test_strace',
3410
'bzrlib.tests.test_subsume',
3411
'bzrlib.tests.test_switch',
3412
'bzrlib.tests.test_symbol_versioning',
3413
'bzrlib.tests.test_tag',
3414
'bzrlib.tests.test_testament',
3415
'bzrlib.tests.test_textfile',
3416
'bzrlib.tests.test_textmerge',
3417
'bzrlib.tests.test_timestamp',
3418
'bzrlib.tests.test_trace',
3419
'bzrlib.tests.test_transactions',
3420
'bzrlib.tests.test_transform',
3421
'bzrlib.tests.test_transport',
3422
'bzrlib.tests.test_transport_implementations',
3423
'bzrlib.tests.test_transport_log',
3424
'bzrlib.tests.test_tree',
3425
'bzrlib.tests.test_treebuilder',
3426
'bzrlib.tests.test_tsort',
3427
'bzrlib.tests.test_tuned_gzip',
3428
'bzrlib.tests.test_ui',
3429
'bzrlib.tests.test_uncommit',
3430
'bzrlib.tests.test_upgrade',
3431
'bzrlib.tests.test_upgrade_stacked',
3432
'bzrlib.tests.test_urlutils',
3433
'bzrlib.tests.test_version',
3434
'bzrlib.tests.test_version_info',
3435
'bzrlib.tests.test_versionedfile',
3436
'bzrlib.tests.test_weave',
3437
'bzrlib.tests.test_whitebox',
3438
'bzrlib.tests.test_win32utils',
3439
'bzrlib.tests.test_workingtree',
3440
'bzrlib.tests.test_workingtree_4',
3441
'bzrlib.tests.test_wsgi',
3442
'bzrlib.tests.test_xml',
3443
'bzrlib.tests.tree_implementations',
3444
'bzrlib.tests.workingtree_implementations',
3445
'bzrlib.util.tests.test_bencode',
3448
loader = TestUtil.TestLoader()
3451
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3452
for start in starting_with]
3453
# We take precedence over keep_only because *at loading time* using
3454
# both options means we will load less tests for the same final result.
3455
def interesting_module(name):
3456
for start in starting_with:
3458
# Either the module name starts with the specified string
3459
name.startswith(start)
3460
# or it may contain tests starting with the specified string
3461
or start.startswith(name)
3465
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3467
elif keep_only is not None:
3468
id_filter = TestIdList(keep_only)
3469
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3470
def interesting_module(name):
3471
return id_filter.refers_to(name)
3474
loader = TestUtil.TestLoader()
3475
def interesting_module(name):
3476
# No filtering, all modules are interesting
3479
suite = loader.suiteClass()
3481
# modules building their suite with loadTestsFromModuleNames
3482
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3484
modules_to_doctest = [
3486
'bzrlib.branchbuilder',
3489
'bzrlib.iterablefile',
3493
'bzrlib.symbol_versioning',
3496
'bzrlib.version_info_formats.format_custom',
3499
for mod in modules_to_doctest:
3500
if not interesting_module(mod):
3501
# No tests to keep here, move along
3504
# note that this really does mean "report only" -- doctest
3505
# still runs the rest of the examples
3506
doc_suite = doctest.DocTestSuite(mod,
3507
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3508
except ValueError, e:
3509
print '**failed to get doctest for: %s\n%s' % (mod, e)
3511
if len(doc_suite._tests) == 0:
3512
raise errors.BzrError("no doctests found in %s" % (mod,))
3513
suite.addTest(doc_suite)
3515
default_encoding = sys.getdefaultencoding()
3516
for name, plugin in bzrlib.plugin.plugins().items():
3517
if not interesting_module(plugin.module.__name__):
3519
plugin_suite = plugin.test_suite()
3520
# We used to catch ImportError here and turn it into just a warning,
3521
# but really if you don't have --no-plugins this should be a failure.
3522
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3523
if plugin_suite is None:
3524
plugin_suite = plugin.load_plugin_tests(loader)
3525
if plugin_suite is not None:
3526
suite.addTest(plugin_suite)
3527
if default_encoding != sys.getdefaultencoding():
3528
bzrlib.trace.warning(
3529
'Plugin "%s" tried to reset default encoding to: %s', name,
3530
sys.getdefaultencoding())
3532
sys.setdefaultencoding(default_encoding)
3535
suite = filter_suite_by_id_startswith(suite, starting_with)
3537
if keep_only is not None:
3538
# Now that the referred modules have loaded their tests, keep only the
3540
suite = filter_suite_by_id_list(suite, id_filter)
3541
# Do some sanity checks on the id_list filtering
3542
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3544
# The tester has used both keep_only and starting_with, so he is
3545
# already aware that some tests are excluded from the list, there
3546
# is no need to tell him which.
3549
# Some tests mentioned in the list are not in the test suite. The
3550
# list may be out of date, report to the tester.
3551
for id in not_found:
3552
bzrlib.trace.warning('"%s" not found in the test suite', id)
3553
for id in duplicates:
3554
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3559
def multiply_scenarios(scenarios_left, scenarios_right):
3560
"""Multiply two sets of scenarios.
3562
:returns: the cartesian product of the two sets of scenarios, that is
3563
a scenario for every possible combination of a left scenario and a
3567
('%s,%s' % (left_name, right_name),
3568
dict(left_dict.items() + right_dict.items()))
3569
for left_name, left_dict in scenarios_left
3570
for right_name, right_dict in scenarios_right]
3573
def multiply_tests(tests, scenarios, result):
3574
"""Multiply tests_list by scenarios into result.
3576
This is the core workhorse for test parameterisation.
3578
Typically the load_tests() method for a per-implementation test suite will
3579
call multiply_tests and return the result.
3581
:param tests: The tests to parameterise.
3582
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3583
scenario_param_dict).
3584
:param result: A TestSuite to add created tests to.
3586
This returns the passed in result TestSuite with the cross product of all
3587
the tests repeated once for each scenario. Each test is adapted by adding
3588
the scenario name at the end of its id(), and updating the test object's
3589
__dict__ with the scenario_param_dict.
3591
>>> r = multiply_tests(
3592
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3593
... [('one', dict(param=1)),
3594
... ('two', dict(param=2))],
3596
>>> tests = list(iter_suite_tests(r))
3600
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3606
for test in iter_suite_tests(tests):
3607
apply_scenarios(test, scenarios, result)
3611
def apply_scenarios(test, scenarios, result):
3612
"""Apply the scenarios in scenarios to test and add to result.
3614
:param test: The test to apply scenarios to.
3615
:param scenarios: An iterable of scenarios to apply to test.
3617
:seealso: apply_scenario
3619
for scenario in scenarios:
3620
result.addTest(apply_scenario(test, scenario))
3624
def apply_scenario(test, scenario):
3625
"""Copy test and apply scenario to it.
3627
:param test: A test to adapt.
3628
:param scenario: A tuple describing the scenarion.
3629
The first element of the tuple is the new test id.
3630
The second element is a dict containing attributes to set on the
3632
:return: The adapted test.
3634
new_id = "%s(%s)" % (test.id(), scenario[0])
3635
new_test = clone_test(test, new_id)
3636
for name, value in scenario[1].items():
3637
setattr(new_test, name, value)
3641
def clone_test(test, new_id):
3642
"""Clone a test giving it a new id.
3644
:param test: The test to clone.
3645
:param new_id: The id to assign to it.
3646
:return: The new test.
3648
from copy import deepcopy
3649
new_test = deepcopy(test)
3650
new_test.id = lambda: new_id
3654
def _rmtree_temp_dir(dirname):
3655
# If LANG=C we probably have created some bogus paths
3656
# which rmtree(unicode) will fail to delete
3657
# so make sure we are using rmtree(str) to delete everything
3658
# except on win32, where rmtree(str) will fail
3659
# since it doesn't have the property of byte-stream paths
3660
# (they are either ascii or mbcs)
3661
if sys.platform == 'win32':
3662
# make sure we are using the unicode win32 api
3663
dirname = unicode(dirname)
3665
dirname = dirname.encode(sys.getfilesystemencoding())
3667
osutils.rmtree(dirname)
3669
if sys.platform == 'win32' and e.errno == errno.EACCES:
3670
sys.stderr.write(('Permission denied: '
3671
'unable to remove testing dir '
3672
'%s\n' % os.path.basename(dirname)))
3677
class Feature(object):
3678
"""An operating system Feature."""
3681
self._available = None
3683
def available(self):
3684
"""Is the feature available?
3686
:return: True if the feature is available.
3688
if self._available is None:
3689
self._available = self._probe()
3690
return self._available
3693
"""Implement this method in concrete features.
3695
:return: True if the feature is available.
3697
raise NotImplementedError
3700
if getattr(self, 'feature_name', None):
3701
return self.feature_name()
3702
return self.__class__.__name__
3705
class _SymlinkFeature(Feature):
3708
return osutils.has_symlinks()
3710
def feature_name(self):
3713
SymlinkFeature = _SymlinkFeature()
3716
class _HardlinkFeature(Feature):
3719
return osutils.has_hardlinks()
3721
def feature_name(self):
3724
HardlinkFeature = _HardlinkFeature()
3727
class _OsFifoFeature(Feature):
3730
return getattr(os, 'mkfifo', None)
3732
def feature_name(self):
3733
return 'filesystem fifos'
3735
OsFifoFeature = _OsFifoFeature()
3738
class _UnicodeFilenameFeature(Feature):
3739
"""Does the filesystem support Unicode filenames?"""
3743
# Check for character combinations unlikely to be covered by any
3744
# single non-unicode encoding. We use the characters
3745
# - greek small letter alpha (U+03B1) and
3746
# - braille pattern dots-123456 (U+283F).
3747
os.stat(u'\u03b1\u283f')
3748
except UnicodeEncodeError:
3750
except (IOError, OSError):
3751
# The filesystem allows the Unicode filename but the file doesn't
3755
# The filesystem allows the Unicode filename and the file exists,
3759
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3762
def probe_unicode_in_user_encoding():
3763
"""Try to encode several unicode strings to use in unicode-aware tests.
3764
Return first successfull match.
3766
:return: (unicode value, encoded plain string value) or (None, None)
3768
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3769
for uni_val in possible_vals:
3771
str_val = uni_val.encode(osutils.get_user_encoding())
3772
except UnicodeEncodeError:
3773
# Try a different character
3776
return uni_val, str_val
3780
def probe_bad_non_ascii(encoding):
3781
"""Try to find [bad] character with code [128..255]
3782
that cannot be decoded to unicode in some encoding.
3783
Return None if all non-ascii characters is valid
3786
for i in xrange(128, 256):
3789
char.decode(encoding)
3790
except UnicodeDecodeError:
3795
class _HTTPSServerFeature(Feature):
3796
"""Some tests want an https Server, check if one is available.
3798
Right now, the only way this is available is under python2.6 which provides
3809
def feature_name(self):
3810
return 'HTTPSServer'
3813
HTTPSServerFeature = _HTTPSServerFeature()
3816
class _UnicodeFilename(Feature):
3817
"""Does the filesystem support Unicode filenames?"""
3822
except UnicodeEncodeError:
3824
except (IOError, OSError):
3825
# The filesystem allows the Unicode filename but the file doesn't
3829
# The filesystem allows the Unicode filename and the file exists,
3833
UnicodeFilename = _UnicodeFilename()
3836
class _UTF8Filesystem(Feature):
3837
"""Is the filesystem UTF-8?"""
3840
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3844
UTF8Filesystem = _UTF8Filesystem()
3847
class _CaseInsCasePresFilenameFeature(Feature):
3848
"""Is the file-system case insensitive, but case-preserving?"""
3851
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3853
# first check truly case-preserving for created files, then check
3854
# case insensitive when opening existing files.
3855
name = osutils.normpath(name)
3856
base, rel = osutils.split(name)
3857
found_rel = osutils.canonical_relpath(base, name)
3858
return (found_rel == rel
3859
and os.path.isfile(name.upper())
3860
and os.path.isfile(name.lower()))
3865
def feature_name(self):
3866
return "case-insensitive case-preserving filesystem"
3868
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3871
class _CaseInsensitiveFilesystemFeature(Feature):
3872
"""Check if underlying filesystem is case-insensitive but *not* case
3875
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3876
# more likely to be case preserving, so this case is rare.
3879
if CaseInsCasePresFilenameFeature.available():
3882
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3883
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3884
TestCaseWithMemoryTransport.TEST_ROOT = root
3886
root = TestCaseWithMemoryTransport.TEST_ROOT
3887
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3889
name_a = osutils.pathjoin(tdir, 'a')
3890
name_A = osutils.pathjoin(tdir, 'A')
3892
result = osutils.isdir(name_A)
3893
_rmtree_temp_dir(tdir)
3896
def feature_name(self):
3897
return 'case-insensitive filesystem'
3899
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3902
class _SubUnitFeature(Feature):
3903
"""Check if subunit is available."""
3912
def feature_name(self):
3915
SubUnitFeature = _SubUnitFeature()
3916
# Only define SubUnitBzrRunner if subunit is available.
3918
from subunit import TestProtocolClient
3919
class SubUnitBzrRunner(TextTestRunner):
3920
def run(self, test):
3921
# undo out claim for testing which looks like a test start to subunit
3922
self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
3923
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
