1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
76
from bzrlib.revision import common_ancestor
78
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.EncodingAdapter import EncodingTestAdapter
98
from bzrlib.tests.treeshape import build_tree_contents
99
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
101
# Mark this python module as being part of the implementation
102
# of unittest: this gives us better tracebacks where the last
103
# shown frame is the test code, not our assertXYZ.
106
default_transport = LocalURLServer
109
MODULES_TO_DOCTEST = [
119
# quoted to avoid module-loading circularity
124
def packages_to_test():
125
"""Return a list of packages to test.
127
The packages are not globally imported so that import failures are
128
triggered when running selftest, not when importing the command.
131
import bzrlib.tests.blackbox
132
import bzrlib.tests.branch_implementations
133
import bzrlib.tests.bzrdir_implementations
134
import bzrlib.tests.commands
135
import bzrlib.tests.interrepository_implementations
136
import bzrlib.tests.interversionedfile_implementations
137
import bzrlib.tests.intertree_implementations
138
import bzrlib.tests.inventory_implementations
139
import bzrlib.tests.per_lock
140
import bzrlib.tests.repository_implementations
141
import bzrlib.tests.revisionstore_implementations
142
import bzrlib.tests.tree_implementations
143
import bzrlib.tests.workingtree_implementations
146
bzrlib.tests.blackbox,
147
bzrlib.tests.branch_implementations,
148
bzrlib.tests.bzrdir_implementations,
149
bzrlib.tests.commands,
150
bzrlib.tests.interrepository_implementations,
151
bzrlib.tests.interversionedfile_implementations,
152
bzrlib.tests.intertree_implementations,
153
bzrlib.tests.inventory_implementations,
154
bzrlib.tests.per_lock,
155
bzrlib.tests.repository_implementations,
156
bzrlib.tests.revisionstore_implementations,
157
bzrlib.tests.tree_implementations,
158
bzrlib.tests.workingtree_implementations,
162
class ExtendedTestResult(unittest._TextTestResult):
163
"""Accepts, reports and accumulates the results of running tests.
165
Compared to the unittest version this class adds support for
166
profiling, benchmarking, stopping as soon as a test fails, and
167
skipping tests. There are further-specialized subclasses for
168
different types of display.
170
When a test finishes, in whatever way, it calls one of the addSuccess,
171
addFailure or addError classes. These in turn may redirect to a more
172
specific case for the special test results supported by our extended
175
Note that just one of these objects is fed the results from many tests.
180
def __init__(self, stream, descriptions, verbosity,
184
"""Construct new TestResult.
186
:param bench_history: Optionally, a writable file object to accumulate
189
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
190
if bench_history is not None:
191
from bzrlib.version import _get_bzr_source_tree
192
src_tree = _get_bzr_source_tree()
195
revision_id = src_tree.get_parent_ids()[0]
197
# XXX: if this is a brand new tree, do the same as if there
201
# XXX: If there's no branch, what should we do?
203
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
204
self._bench_history = bench_history
205
self.ui = ui.ui_factory
206
self.num_tests = num_tests
208
self.failure_count = 0
209
self.known_failure_count = 0
211
self.not_applicable_count = 0
212
self.unsupported = {}
214
self._overall_start_time = time.time()
216
def _extractBenchmarkTime(self, testCase):
217
"""Add a benchmark time for the current test case."""
218
return getattr(testCase, "_benchtime", None)
220
def _elapsedTestTimeString(self):
221
"""Return a time string for the overall time the current test has taken."""
222
return self._formatTime(time.time() - self._start_time)
224
def _testTimeString(self, testCase):
225
benchmark_time = self._extractBenchmarkTime(testCase)
226
if benchmark_time is not None:
228
self._formatTime(benchmark_time),
229
self._elapsedTestTimeString())
231
return " %s" % self._elapsedTestTimeString()
233
def _formatTime(self, seconds):
234
"""Format seconds as milliseconds with leading spaces."""
235
# some benchmarks can take thousands of seconds to run, so we need 8
237
return "%8dms" % (1000 * seconds)
239
def _shortened_test_description(self, test):
241
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
244
def startTest(self, test):
245
unittest.TestResult.startTest(self, test)
246
self.report_test_start(test)
247
test.number = self.count
248
self._recordTestStartTime()
250
def _recordTestStartTime(self):
251
"""Record that a test has started."""
252
self._start_time = time.time()
254
def _cleanupLogFile(self, test):
255
# We can only do this if we have one of our TestCases, not if
257
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
258
if setKeepLogfile is not None:
261
def addError(self, test, err):
262
"""Tell result that test finished with an error.
264
Called from the TestCase run() method when the test
265
fails with an unexpected error.
267
self._testConcluded(test)
268
if isinstance(err[1], TestSkipped):
269
return self._addSkipped(test, err)
270
elif isinstance(err[1], UnavailableFeature):
271
return self.addNotSupported(test, err[1].args[0])
273
unittest.TestResult.addError(self, test, err)
274
self.error_count += 1
275
self.report_error(test, err)
279
def addFailure(self, test, err):
280
"""Tell result that test failed.
282
Called from the TestCase run() method when the test
283
fails because e.g. an assert() method failed.
285
self._testConcluded(test)
286
if isinstance(err[1], KnownFailure):
287
return self._addKnownFailure(test, err)
289
unittest.TestResult.addFailure(self, test, err)
290
self.failure_count += 1
291
self.report_failure(test, err)
295
def addSuccess(self, test):
296
"""Tell result that test completed successfully.
298
Called from the TestCase run()
300
self._testConcluded(test)
301
if self._bench_history is not None:
302
benchmark_time = self._extractBenchmarkTime(test)
303
if benchmark_time is not None:
304
self._bench_history.write("%s %s\n" % (
305
self._formatTime(benchmark_time),
307
self.report_success(test)
308
unittest.TestResult.addSuccess(self, test)
310
def _testConcluded(self, test):
311
"""Common code when a test has finished.
313
Called regardless of whether it succeded, failed, etc.
315
self._cleanupLogFile(test)
317
def _addKnownFailure(self, test, err):
318
self.known_failure_count += 1
319
self.report_known_failure(test, err)
321
def addNotSupported(self, test, feature):
322
"""The test will not be run because of a missing feature.
324
# this can be called in two different ways: it may be that the
325
# test started running, and then raised (through addError)
326
# UnavailableFeature. Alternatively this method can be called
327
# while probing for features before running the tests; in that
328
# case we will see startTest and stopTest, but the test will never
330
self.unsupported.setdefault(str(feature), 0)
331
self.unsupported[str(feature)] += 1
332
self.report_unsupported(test, feature)
334
def _addSkipped(self, test, skip_excinfo):
335
if isinstance(skip_excinfo[1], TestNotApplicable):
336
self.not_applicable_count += 1
337
self.report_not_applicable(test, skip_excinfo)
340
self.report_skip(test, skip_excinfo)
343
except KeyboardInterrupt:
346
self.addError(test, test._exc_info())
348
# seems best to treat this as success from point-of-view of unittest
349
# -- it actually does nothing so it barely matters :)
350
unittest.TestResult.addSuccess(self, test)
352
def printErrorList(self, flavour, errors):
353
for test, err in errors:
354
self.stream.writeln(self.separator1)
355
self.stream.write("%s: " % flavour)
356
self.stream.writeln(self.getDescription(test))
357
if getattr(test, '_get_log', None) is not None:
358
self.stream.write('\n')
360
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
361
self.stream.write('\n')
362
self.stream.write(test._get_log())
363
self.stream.write('\n')
365
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
366
self.stream.write('\n')
367
self.stream.writeln(self.separator2)
368
self.stream.writeln("%s" % err)
373
def report_cleaning_up(self):
376
def report_success(self, test):
379
def wasStrictlySuccessful(self):
380
if self.unsupported or self.known_failure_count:
382
return self.wasSuccessful()
385
class TextTestResult(ExtendedTestResult):
386
"""Displays progress and results of tests in text form"""
388
def __init__(self, stream, descriptions, verbosity,
393
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
394
bench_history, num_tests)
396
self.pb = self.ui.nested_progress_bar()
397
self._supplied_pb = False
400
self._supplied_pb = True
401
self.pb.show_pct = False
402
self.pb.show_spinner = False
403
self.pb.show_eta = False,
404
self.pb.show_count = False
405
self.pb.show_bar = False
407
def report_starting(self):
408
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
410
def _progress_prefix_text(self):
411
a = '[%d' % self.count
412
if self.num_tests is not None:
413
a +='/%d' % self.num_tests
414
a += ' in %ds' % (time.time() - self._overall_start_time)
416
a += ', %d errors' % self.error_count
417
if self.failure_count:
418
a += ', %d failed' % self.failure_count
419
if self.known_failure_count:
420
a += ', %d known failures' % self.known_failure_count
422
a += ', %d skipped' % self.skip_count
424
a += ', %d missing features' % len(self.unsupported)
428
def report_test_start(self, test):
431
self._progress_prefix_text()
433
+ self._shortened_test_description(test))
435
def _test_description(self, test):
436
return self._shortened_test_description(test)
438
def report_error(self, test, err):
439
self.pb.note('ERROR: %s\n %s\n',
440
self._test_description(test),
444
def report_failure(self, test, err):
445
self.pb.note('FAIL: %s\n %s\n',
446
self._test_description(test),
450
def report_known_failure(self, test, err):
451
self.pb.note('XFAIL: %s\n%s\n',
452
self._test_description(test), err[1])
454
def report_skip(self, test, skip_excinfo):
457
def report_not_applicable(self, test, skip_excinfo):
460
def report_unsupported(self, test, feature):
461
"""test cannot be run because feature is missing."""
463
def report_cleaning_up(self):
464
self.pb.update('cleaning up...')
467
if not self._supplied_pb:
471
class VerboseTestResult(ExtendedTestResult):
472
"""Produce long output, with one line per test run plus times"""
474
def _ellipsize_to_right(self, a_string, final_width):
475
"""Truncate and pad a string, keeping the right hand side"""
476
if len(a_string) > final_width:
477
result = '...' + a_string[3-final_width:]
480
return result.ljust(final_width)
482
def report_starting(self):
483
self.stream.write('running %d tests...\n' % self.num_tests)
485
def report_test_start(self, test):
487
name = self._shortened_test_description(test)
488
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
489
# numbers, plus a trailing blank
490
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
491
self.stream.write(self._ellipsize_to_right(name,
492
osutils.terminal_width()-30))
495
def _error_summary(self, err):
497
return '%s%s' % (indent, err[1])
499
def report_error(self, test, err):
500
self.stream.writeln('ERROR %s\n%s'
501
% (self._testTimeString(test),
502
self._error_summary(err)))
504
def report_failure(self, test, err):
505
self.stream.writeln(' FAIL %s\n%s'
506
% (self._testTimeString(test),
507
self._error_summary(err)))
509
def report_known_failure(self, test, err):
510
self.stream.writeln('XFAIL %s\n%s'
511
% (self._testTimeString(test),
512
self._error_summary(err)))
514
def report_success(self, test):
515
self.stream.writeln(' OK %s' % self._testTimeString(test))
516
for bench_called, stats in getattr(test, '_benchcalls', []):
517
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
518
stats.pprint(file=self.stream)
519
# flush the stream so that we get smooth output. This verbose mode is
520
# used to show the output in PQM.
523
def report_skip(self, test, skip_excinfo):
524
self.stream.writeln(' SKIP %s\n%s'
525
% (self._testTimeString(test),
526
self._error_summary(skip_excinfo)))
528
def report_not_applicable(self, test, skip_excinfo):
529
self.stream.writeln(' N/A %s\n%s'
530
% (self._testTimeString(test),
531
self._error_summary(skip_excinfo)))
533
def report_unsupported(self, test, feature):
534
"""test cannot be run because feature is missing."""
535
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
536
%(self._testTimeString(test), feature))
539
class TextTestRunner(object):
540
stop_on_failure = False
549
self.stream = unittest._WritelnDecorator(stream)
550
self.descriptions = descriptions
551
self.verbosity = verbosity
552
self._bench_history = bench_history
553
self.list_only = list_only
556
"Run the given test case or test suite."
557
startTime = time.time()
558
if self.verbosity == 1:
559
result_class = TextTestResult
560
elif self.verbosity >= 2:
561
result_class = VerboseTestResult
562
result = result_class(self.stream,
565
bench_history=self._bench_history,
566
num_tests=test.countTestCases(),
568
result.stop_early = self.stop_on_failure
569
result.report_starting()
571
if self.verbosity >= 2:
572
self.stream.writeln("Listing tests only ...\n")
574
for t in iter_suite_tests(test):
575
self.stream.writeln("%s" % (t.id()))
577
actionTaken = "Listed"
580
run = result.testsRun
582
stopTime = time.time()
583
timeTaken = stopTime - startTime
585
self.stream.writeln(result.separator2)
586
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
587
run, run != 1 and "s" or "", timeTaken))
588
self.stream.writeln()
589
if not result.wasSuccessful():
590
self.stream.write("FAILED (")
591
failed, errored = map(len, (result.failures, result.errors))
593
self.stream.write("failures=%d" % failed)
595
if failed: self.stream.write(", ")
596
self.stream.write("errors=%d" % errored)
597
if result.known_failure_count:
598
if failed or errored: self.stream.write(", ")
599
self.stream.write("known_failure_count=%d" %
600
result.known_failure_count)
601
self.stream.writeln(")")
603
if result.known_failure_count:
604
self.stream.writeln("OK (known_failures=%d)" %
605
result.known_failure_count)
607
self.stream.writeln("OK")
608
if result.skip_count > 0:
609
skipped = result.skip_count
610
self.stream.writeln('%d test%s skipped' %
611
(skipped, skipped != 1 and "s" or ""))
612
if result.unsupported:
613
for feature, count in sorted(result.unsupported.items()):
614
self.stream.writeln("Missing feature '%s' skipped %d tests." %
620
def iter_suite_tests(suite):
621
"""Return all tests in a suite, recursing through nested suites"""
622
for item in suite._tests:
623
if isinstance(item, unittest.TestCase):
625
elif isinstance(item, unittest.TestSuite):
626
for r in iter_suite_tests(item):
629
raise Exception('unknown object %r inside test suite %r'
633
class TestSkipped(Exception):
634
"""Indicates that a test was intentionally skipped, rather than failing."""
637
class TestNotApplicable(TestSkipped):
638
"""A test is not applicable to the situation where it was run.
640
This is only normally raised by parameterized tests, if they find that
641
the instance they're constructed upon does not support one aspect
646
class KnownFailure(AssertionError):
647
"""Indicates that a test failed in a precisely expected manner.
649
Such failures dont block the whole test suite from passing because they are
650
indicators of partially completed code or of future work. We have an
651
explicit error for them so that we can ensure that they are always visible:
652
KnownFailures are always shown in the output of bzr selftest.
656
class UnavailableFeature(Exception):
657
"""A feature required for this test was not available.
659
The feature should be used to construct the exception.
663
class CommandFailed(Exception):
667
class StringIOWrapper(object):
668
"""A wrapper around cStringIO which just adds an encoding attribute.
670
Internally we can check sys.stdout to see what the output encoding
671
should be. However, cStringIO has no encoding attribute that we can
672
set. So we wrap it instead.
677
def __init__(self, s=None):
679
self.__dict__['_cstring'] = StringIO(s)
681
self.__dict__['_cstring'] = StringIO()
683
def __getattr__(self, name, getattr=getattr):
684
return getattr(self.__dict__['_cstring'], name)
686
def __setattr__(self, name, val):
687
if name == 'encoding':
688
self.__dict__['encoding'] = val
690
return setattr(self._cstring, name, val)
693
class TestUIFactory(ui.CLIUIFactory):
694
"""A UI Factory for testing.
696
Hide the progress bar but emit note()s.
698
Allows get_password to be tested without real tty attached.
705
super(TestUIFactory, self).__init__()
706
if stdin is not None:
707
# We use a StringIOWrapper to be able to test various
708
# encodings, but the user is still responsible to
709
# encode the string and to set the encoding attribute
710
# of StringIOWrapper.
711
self.stdin = StringIOWrapper(stdin)
713
self.stdout = sys.stdout
717
self.stderr = sys.stderr
722
"""See progress.ProgressBar.clear()."""
724
def clear_term(self):
725
"""See progress.ProgressBar.clear_term()."""
727
def clear_term(self):
728
"""See progress.ProgressBar.clear_term()."""
731
"""See progress.ProgressBar.finished()."""
733
def note(self, fmt_string, *args, **kwargs):
734
"""See progress.ProgressBar.note()."""
735
self.stdout.write((fmt_string + "\n") % args)
737
def progress_bar(self):
740
def nested_progress_bar(self):
743
def update(self, message, count=None, total=None):
744
"""See progress.ProgressBar.update()."""
746
def get_non_echoed_password(self, prompt):
747
"""Get password from stdin without trying to handle the echo mode"""
749
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
750
password = self.stdin.readline()
753
if password[-1] == '\n':
754
password = password[:-1]
758
class TestCase(unittest.TestCase):
759
"""Base class for bzr unit tests.
761
Tests that need access to disk resources should subclass
762
TestCaseInTempDir not TestCase.
764
Error and debug log messages are redirected from their usual
765
location into a temporary file, the contents of which can be
766
retrieved by _get_log(). We use a real OS file, not an in-memory object,
767
so that it can also capture file IO. When the test completes this file
768
is read into memory and removed from disk.
770
There are also convenience functions to invoke bzr's command-line
771
routine, and to build and check bzr trees.
773
In addition to the usual method of overriding tearDown(), this class also
774
allows subclasses to register functions into the _cleanups list, which is
775
run in order as the object is torn down. It's less likely this will be
776
accidentally overlooked.
779
_log_file_name = None
781
_keep_log_file = False
782
# record lsprof data when performing benchmark calls.
783
_gather_lsprof_in_benchmarks = False
785
def __init__(self, methodName='testMethod'):
786
super(TestCase, self).__init__(methodName)
790
unittest.TestCase.setUp(self)
791
self._cleanEnvironment()
792
bzrlib.trace.disable_default_logging()
795
self._benchcalls = []
796
self._benchtime = None
798
self._clear_debug_flags()
800
def _clear_debug_flags(self):
801
"""Prevent externally set debug flags affecting tests.
803
Tests that want to use debug flags can just set them in the
804
debug_flags set during setup/teardown.
806
self._preserved_debug_flags = set(debug.debug_flags)
807
debug.debug_flags.clear()
808
self.addCleanup(self._restore_debug_flags)
810
def _clear_hooks(self):
811
# prevent hooks affecting tests
813
import bzrlib.smart.server
814
self._preserved_hooks = {
815
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
816
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
818
self.addCleanup(self._restoreHooks)
819
# reset all hooks to an empty instance of the appropriate type
820
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
821
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
823
def _silenceUI(self):
824
"""Turn off UI for duration of test"""
825
# by default the UI is off; tests can turn it on if they want it.
826
saved = ui.ui_factory
828
ui.ui_factory = saved
829
ui.ui_factory = ui.SilentUIFactory()
830
self.addCleanup(_restore)
832
def _ndiff_strings(self, a, b):
833
"""Return ndiff between two strings containing lines.
835
A trailing newline is added if missing to make the strings
837
if b and b[-1] != '\n':
839
if a and a[-1] != '\n':
841
difflines = difflib.ndiff(a.splitlines(True),
843
linejunk=lambda x: False,
844
charjunk=lambda x: False)
845
return ''.join(difflines)
847
def assertEqual(self, a, b, message=''):
851
except UnicodeError, e:
852
# If we can't compare without getting a UnicodeError, then
853
# obviously they are different
854
mutter('UnicodeError: %s', e)
857
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
859
pformat(a), pformat(b)))
861
assertEquals = assertEqual
863
def assertEqualDiff(self, a, b, message=None):
864
"""Assert two texts are equal, if not raise an exception.
866
This is intended for use with multi-line strings where it can
867
be hard to find the differences by eye.
869
# TODO: perhaps override assertEquals to call this for strings?
873
message = "texts not equal:\n"
874
raise AssertionError(message +
875
self._ndiff_strings(a, b))
877
def assertEqualMode(self, mode, mode_test):
878
self.assertEqual(mode, mode_test,
879
'mode mismatch %o != %o' % (mode, mode_test))
881
def assertPositive(self, val):
882
"""Assert that val is greater than 0."""
883
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
885
def assertNegative(self, val):
886
"""Assert that val is less than 0."""
887
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
889
def assertStartsWith(self, s, prefix):
890
if not s.startswith(prefix):
891
raise AssertionError('string %r does not start with %r' % (s, prefix))
893
def assertEndsWith(self, s, suffix):
894
"""Asserts that s ends with suffix."""
895
if not s.endswith(suffix):
896
raise AssertionError('string %r does not end with %r' % (s, suffix))
898
def assertContainsRe(self, haystack, needle_re):
899
"""Assert that a contains something matching a regular expression."""
900
if not re.search(needle_re, haystack):
901
if '\n' in haystack or len(haystack) > 60:
902
# a long string, format it in a more readable way
903
raise AssertionError(
904
'pattern "%s" not found in\n"""\\\n%s"""\n'
905
% (needle_re, haystack))
907
raise AssertionError('pattern "%s" not found in "%s"'
908
% (needle_re, haystack))
910
def assertNotContainsRe(self, haystack, needle_re):
911
"""Assert that a does not match a regular expression"""
912
if re.search(needle_re, haystack):
913
raise AssertionError('pattern "%s" found in "%s"'
914
% (needle_re, haystack))
916
def assertSubset(self, sublist, superlist):
917
"""Assert that every entry in sublist is present in superlist."""
918
missing = set(sublist) - set(superlist)
920
raise AssertionError("value(s) %r not present in container %r" %
921
(missing, superlist))
923
def assertListRaises(self, excClass, func, *args, **kwargs):
924
"""Fail unless excClass is raised when the iterator from func is used.
926
Many functions can return generators this makes sure
927
to wrap them in a list() call to make sure the whole generator
928
is run, and that the proper exception is raised.
931
list(func(*args, **kwargs))
935
if getattr(excClass,'__name__', None) is not None:
936
excName = excClass.__name__
938
excName = str(excClass)
939
raise self.failureException, "%s not raised" % excName
941
def assertRaises(self, excClass, callableObj, *args, **kwargs):
942
"""Assert that a callable raises a particular exception.
944
:param excClass: As for the except statement, this may be either an
945
exception class, or a tuple of classes.
946
:param callableObj: A callable, will be passed ``*args`` and
949
Returns the exception so that you can examine it.
952
callableObj(*args, **kwargs)
956
if getattr(excClass,'__name__', None) is not None:
957
excName = excClass.__name__
960
excName = str(excClass)
961
raise self.failureException, "%s not raised" % excName
963
def assertIs(self, left, right, message=None):
964
if not (left is right):
965
if message is not None:
966
raise AssertionError(message)
968
raise AssertionError("%r is not %r." % (left, right))
970
def assertIsNot(self, left, right, message=None):
972
if message is not None:
973
raise AssertionError(message)
975
raise AssertionError("%r is %r." % (left, right))
977
def assertTransportMode(self, transport, path, mode):
978
"""Fail if a path does not have mode mode.
980
If modes are not supported on this transport, the assertion is ignored.
982
if not transport._can_roundtrip_unix_modebits():
984
path_stat = transport.stat(path)
985
actual_mode = stat.S_IMODE(path_stat.st_mode)
986
self.assertEqual(mode, actual_mode,
987
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
989
def assertIsSameRealPath(self, path1, path2):
990
"""Fail if path1 and path2 points to different files"""
991
self.assertEqual(osutils.realpath(path1),
992
osutils.realpath(path2),
993
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
995
def assertIsInstance(self, obj, kls):
996
"""Fail if obj is not an instance of kls"""
997
if not isinstance(obj, kls):
998
self.fail("%r is an instance of %s rather than %s" % (
999
obj, obj.__class__, kls))
1001
def expectFailure(self, reason, assertion, *args, **kwargs):
1002
"""Invoke a test, expecting it to fail for the given reason.
1004
This is for assertions that ought to succeed, but currently fail.
1005
(The failure is *expected* but not *wanted*.) Please be very precise
1006
about the failure you're expecting. If a new bug is introduced,
1007
AssertionError should be raised, not KnownFailure.
1009
Frequently, expectFailure should be followed by an opposite assertion.
1012
Intended to be used with a callable that raises AssertionError as the
1013
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1015
Raises KnownFailure if the test fails. Raises AssertionError if the
1020
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1022
self.assertEqual(42, dynamic_val)
1024
This means that a dynamic_val of 54 will cause the test to raise
1025
a KnownFailure. Once math is fixed and the expectFailure is removed,
1026
only a dynamic_val of 42 will allow the test to pass. Anything other
1027
than 54 or 42 will cause an AssertionError.
1030
assertion(*args, **kwargs)
1031
except AssertionError:
1032
raise KnownFailure(reason)
1034
self.fail('Unexpected success. Should have failed: %s' % reason)
1036
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1037
"""A helper for callDeprecated and applyDeprecated.
1039
:param a_callable: A callable to call.
1040
:param args: The positional arguments for the callable
1041
:param kwargs: The keyword arguments for the callable
1042
:return: A tuple (warnings, result). result is the result of calling
1043
a_callable(``*args``, ``**kwargs``).
1046
def capture_warnings(msg, cls=None, stacklevel=None):
1047
# we've hooked into a deprecation specific callpath,
1048
# only deprecations should getting sent via it.
1049
self.assertEqual(cls, DeprecationWarning)
1050
local_warnings.append(msg)
1051
original_warning_method = symbol_versioning.warn
1052
symbol_versioning.set_warning_method(capture_warnings)
1054
result = a_callable(*args, **kwargs)
1056
symbol_versioning.set_warning_method(original_warning_method)
1057
return (local_warnings, result)
1059
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1060
"""Call a deprecated callable without warning the user.
1062
Note that this only captures warnings raised by symbol_versioning.warn,
1063
not other callers that go direct to the warning module.
1065
To test that a deprecated method raises an error, do something like
1068
self.assertRaises(errors.ReservedId,
1069
self.applyDeprecated, zero_ninetyone,
1070
br.append_revision, 'current:')
1072
:param deprecation_format: The deprecation format that the callable
1073
should have been deprecated with. This is the same type as the
1074
parameter to deprecated_method/deprecated_function. If the
1075
callable is not deprecated with this format, an assertion error
1077
:param a_callable: A callable to call. This may be a bound method or
1078
a regular function. It will be called with ``*args`` and
1080
:param args: The positional arguments for the callable
1081
:param kwargs: The keyword arguments for the callable
1082
:return: The result of a_callable(``*args``, ``**kwargs``)
1084
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1086
expected_first_warning = symbol_versioning.deprecation_string(
1087
a_callable, deprecation_format)
1088
if len(call_warnings) == 0:
1089
self.fail("No deprecation warning generated by call to %s" %
1091
self.assertEqual(expected_first_warning, call_warnings[0])
1094
def callCatchWarnings(self, fn, *args, **kw):
1095
"""Call a callable that raises python warnings.
1097
The caller's responsible for examining the returned warnings.
1099
If the callable raises an exception, the exception is not
1100
caught and propagates up to the caller. In that case, the list
1101
of warnings is not available.
1103
:returns: ([warning_object, ...], fn_result)
1105
# XXX: This is not perfect, because it completely overrides the
1106
# warnings filters, and some code may depend on suppressing particular
1107
# warnings. It's the easiest way to insulate ourselves from -Werror,
1108
# though. -- Andrew, 20071062
1110
def _catcher(message, category, filename, lineno, file=None):
1111
# despite the name, 'message' is normally(?) a Warning subclass
1113
wlist.append(message)
1114
saved_showwarning = warnings.showwarning
1115
saved_filters = warnings.filters
1117
warnings.showwarning = _catcher
1118
warnings.filters = []
1119
result = fn(*args, **kw)
1121
warnings.showwarning = saved_showwarning
1122
warnings.filters = saved_filters
1123
return wlist, result
1125
def callDeprecated(self, expected, callable, *args, **kwargs):
1126
"""Assert that a callable is deprecated in a particular way.
1128
This is a very precise test for unusual requirements. The
1129
applyDeprecated helper function is probably more suited for most tests
1130
as it allows you to simply specify the deprecation format being used
1131
and will ensure that that is issued for the function being called.
1133
Note that this only captures warnings raised by symbol_versioning.warn,
1134
not other callers that go direct to the warning module. To catch
1135
general warnings, use callCatchWarnings.
1137
:param expected: a list of the deprecation warnings expected, in order
1138
:param callable: The callable to call
1139
:param args: The positional arguments for the callable
1140
:param kwargs: The keyword arguments for the callable
1142
call_warnings, result = self._capture_deprecation_warnings(callable,
1144
self.assertEqual(expected, call_warnings)
1147
def _startLogFile(self):
1148
"""Send bzr and test log messages to a temporary file.
1150
The file is removed as the test is torn down.
1152
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1153
self._log_file = os.fdopen(fileno, 'w+')
1154
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1155
self._log_file_name = name
1156
self.addCleanup(self._finishLogFile)
1158
def _finishLogFile(self):
1159
"""Finished with the log file.
1161
Close the file and delete it, unless setKeepLogfile was called.
1163
if self._log_file is None:
1165
bzrlib.trace.disable_test_log(self._log_nonce)
1166
self._log_file.close()
1167
self._log_file = None
1168
if not self._keep_log_file:
1169
os.remove(self._log_file_name)
1170
self._log_file_name = None
1172
def setKeepLogfile(self):
1173
"""Make the logfile not be deleted when _finishLogFile is called."""
1174
self._keep_log_file = True
1176
def addCleanup(self, callable):
1177
"""Arrange to run a callable when this case is torn down.
1179
Callables are run in the reverse of the order they are registered,
1180
ie last-in first-out.
1182
if callable in self._cleanups:
1183
raise ValueError("cleanup function %r already registered on %s"
1185
self._cleanups.append(callable)
1187
def _cleanEnvironment(self):
1189
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1190
'HOME': os.getcwd(),
1191
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1192
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1194
'BZREMAIL': None, # may still be present in the environment
1196
'BZR_PROGRESS_BAR': None,
1198
'SSH_AUTH_SOCK': None,
1202
'https_proxy': None,
1203
'HTTPS_PROXY': None,
1208
# Nobody cares about these ones AFAIK. So far at
1209
# least. If you do (care), please update this comment
1213
'BZR_REMOTE_PATH': None,
1216
self.addCleanup(self._restoreEnvironment)
1217
for name, value in new_env.iteritems():
1218
self._captureVar(name, value)
1220
def _captureVar(self, name, newvalue):
1221
"""Set an environment variable, and reset it when finished."""
1222
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1224
def _restore_debug_flags(self):
1225
debug.debug_flags.clear()
1226
debug.debug_flags.update(self._preserved_debug_flags)
1228
def _restoreEnvironment(self):
1229
for name, value in self.__old_env.iteritems():
1230
osutils.set_or_unset_env(name, value)
1232
def _restoreHooks(self):
1233
for klass, hooks in self._preserved_hooks.items():
1234
setattr(klass, 'hooks', hooks)
1236
def knownFailure(self, reason):
1237
"""This test has failed for some known reason."""
1238
raise KnownFailure(reason)
1240
def run(self, result=None):
1241
if result is None: result = self.defaultTestResult()
1242
for feature in getattr(self, '_test_needs_features', []):
1243
if not feature.available():
1244
result.startTest(self)
1245
if getattr(result, 'addNotSupported', None):
1246
result.addNotSupported(self, feature)
1248
result.addSuccess(self)
1249
result.stopTest(self)
1251
return unittest.TestCase.run(self, result)
1255
unittest.TestCase.tearDown(self)
1257
def time(self, callable, *args, **kwargs):
1258
"""Run callable and accrue the time it takes to the benchmark time.
1260
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1261
this will cause lsprofile statistics to be gathered and stored in
1264
if self._benchtime is None:
1268
if not self._gather_lsprof_in_benchmarks:
1269
return callable(*args, **kwargs)
1271
# record this benchmark
1272
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1274
self._benchcalls.append(((callable, args, kwargs), stats))
1277
self._benchtime += time.time() - start
1279
def _runCleanups(self):
1280
"""Run registered cleanup functions.
1282
This should only be called from TestCase.tearDown.
1284
# TODO: Perhaps this should keep running cleanups even if
1285
# one of them fails?
1287
# Actually pop the cleanups from the list so tearDown running
1288
# twice is safe (this happens for skipped tests).
1289
while self._cleanups:
1290
self._cleanups.pop()()
1292
def log(self, *args):
1295
def _get_log(self, keep_log_file=False):
1296
"""Get the log from bzrlib.trace calls from this test.
1298
:param keep_log_file: When True, if the log is still a file on disk
1299
leave it as a file on disk. When False, if the log is still a file
1300
on disk, the log file is deleted and the log preserved as
1302
:return: A string containing the log.
1304
# flush the log file, to get all content
1306
bzrlib.trace._trace_file.flush()
1307
if self._log_contents:
1308
return self._log_contents
1309
if self._log_file_name is not None:
1310
logfile = open(self._log_file_name)
1312
log_contents = logfile.read()
1315
if not keep_log_file:
1316
self._log_contents = log_contents
1318
os.remove(self._log_file_name)
1320
if sys.platform == 'win32' and e.errno == errno.EACCES:
1321
sys.stderr.write(('Unable to delete log file '
1322
' %r\n' % self._log_file_name))
1327
return "DELETED log file to reduce memory footprint"
1329
def requireFeature(self, feature):
1330
"""This test requires a specific feature is available.
1332
:raises UnavailableFeature: When feature is not available.
1334
if not feature.available():
1335
raise UnavailableFeature(feature)
1337
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1339
"""Run bazaar command line, splitting up a string command line."""
1340
if isinstance(args, basestring):
1341
# shlex don't understand unicode strings,
1342
# so args should be plain string (bialix 20070906)
1343
args = list(shlex.split(str(args)))
1344
return self._run_bzr_core(args, retcode=retcode,
1345
encoding=encoding, stdin=stdin, working_dir=working_dir,
1348
def _run_bzr_core(self, args, retcode, encoding, stdin,
1350
if encoding is None:
1351
encoding = bzrlib.user_encoding
1352
stdout = StringIOWrapper()
1353
stderr = StringIOWrapper()
1354
stdout.encoding = encoding
1355
stderr.encoding = encoding
1357
self.log('run bzr: %r', args)
1358
# FIXME: don't call into logging here
1359
handler = logging.StreamHandler(stderr)
1360
handler.setLevel(logging.INFO)
1361
logger = logging.getLogger('')
1362
logger.addHandler(handler)
1363
old_ui_factory = ui.ui_factory
1364
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1367
if working_dir is not None:
1368
cwd = osutils.getcwd()
1369
os.chdir(working_dir)
1372
result = self.apply_redirected(ui.ui_factory.stdin,
1374
bzrlib.commands.run_bzr_catch_user_errors,
1377
logger.removeHandler(handler)
1378
ui.ui_factory = old_ui_factory
1382
out = stdout.getvalue()
1383
err = stderr.getvalue()
1385
self.log('output:\n%r', out)
1387
self.log('errors:\n%r', err)
1388
if retcode is not None:
1389
self.assertEquals(retcode, result,
1390
message='Unexpected return code')
1393
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1394
working_dir=None, error_regexes=[], output_encoding=None):
1395
"""Invoke bzr, as if it were run from the command line.
1397
The argument list should not include the bzr program name - the
1398
first argument is normally the bzr command. Arguments may be
1399
passed in three ways:
1401
1- A list of strings, eg ["commit", "a"]. This is recommended
1402
when the command contains whitespace or metacharacters, or
1403
is built up at run time.
1405
2- A single string, eg "add a". This is the most convenient
1406
for hardcoded commands.
1408
This runs bzr through the interface that catches and reports
1409
errors, and with logging set to something approximating the
1410
default, so that error reporting can be checked.
1412
This should be the main method for tests that want to exercise the
1413
overall behavior of the bzr application (rather than a unit test
1414
or a functional test of the library.)
1416
This sends the stdout/stderr results into the test's log,
1417
where it may be useful for debugging. See also run_captured.
1419
:keyword stdin: A string to be used as stdin for the command.
1420
:keyword retcode: The status code the command should return;
1422
:keyword working_dir: The directory to run the command in
1423
:keyword error_regexes: A list of expected error messages. If
1424
specified they must be seen in the error output of the command.
1426
out, err = self._run_bzr_autosplit(
1431
working_dir=working_dir,
1433
for regex in error_regexes:
1434
self.assertContainsRe(err, regex)
1437
def run_bzr_error(self, error_regexes, *args, **kwargs):
1438
"""Run bzr, and check that stderr contains the supplied regexes
1440
:param error_regexes: Sequence of regular expressions which
1441
must each be found in the error output. The relative ordering
1443
:param args: command-line arguments for bzr
1444
:param kwargs: Keyword arguments which are interpreted by run_bzr
1445
This function changes the default value of retcode to be 3,
1446
since in most cases this is run when you expect bzr to fail.
1448
:return: (out, err) The actual output of running the command (in case
1449
you want to do more inspection)
1453
# Make sure that commit is failing because there is nothing to do
1454
self.run_bzr_error(['no changes to commit'],
1455
['commit', '-m', 'my commit comment'])
1456
# Make sure --strict is handling an unknown file, rather than
1457
# giving us the 'nothing to do' error
1458
self.build_tree(['unknown'])
1459
self.run_bzr_error(['Commit refused because there are unknown files'],
1460
['commit', --strict', '-m', 'my commit comment'])
1462
kwargs.setdefault('retcode', 3)
1463
kwargs['error_regexes'] = error_regexes
1464
out, err = self.run_bzr(*args, **kwargs)
1467
def run_bzr_subprocess(self, *args, **kwargs):
1468
"""Run bzr in a subprocess for testing.
1470
This starts a new Python interpreter and runs bzr in there.
1471
This should only be used for tests that have a justifiable need for
1472
this isolation: e.g. they are testing startup time, or signal
1473
handling, or early startup code, etc. Subprocess code can't be
1474
profiled or debugged so easily.
1476
:keyword retcode: The status code that is expected. Defaults to 0. If
1477
None is supplied, the status code is not checked.
1478
:keyword env_changes: A dictionary which lists changes to environment
1479
variables. A value of None will unset the env variable.
1480
The values must be strings. The change will only occur in the
1481
child, so you don't need to fix the environment after running.
1482
:keyword universal_newlines: Convert CRLF => LF
1483
:keyword allow_plugins: By default the subprocess is run with
1484
--no-plugins to ensure test reproducibility. Also, it is possible
1485
for system-wide plugins to create unexpected output on stderr,
1486
which can cause unnecessary test failures.
1488
env_changes = kwargs.get('env_changes', {})
1489
working_dir = kwargs.get('working_dir', None)
1490
allow_plugins = kwargs.get('allow_plugins', False)
1492
if isinstance(args[0], list):
1494
elif isinstance(args[0], basestring):
1495
args = list(shlex.split(args[0]))
1497
symbol_versioning.warn(zero_ninetyone %
1498
"passing varargs to run_bzr_subprocess",
1499
DeprecationWarning, stacklevel=3)
1500
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1501
working_dir=working_dir,
1502
allow_plugins=allow_plugins)
1503
# We distinguish between retcode=None and retcode not passed.
1504
supplied_retcode = kwargs.get('retcode', 0)
1505
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1506
universal_newlines=kwargs.get('universal_newlines', False),
1509
def start_bzr_subprocess(self, process_args, env_changes=None,
1510
skip_if_plan_to_signal=False,
1512
allow_plugins=False):
1513
"""Start bzr in a subprocess for testing.
1515
This starts a new Python interpreter and runs bzr in there.
1516
This should only be used for tests that have a justifiable need for
1517
this isolation: e.g. they are testing startup time, or signal
1518
handling, or early startup code, etc. Subprocess code can't be
1519
profiled or debugged so easily.
1521
:param process_args: a list of arguments to pass to the bzr executable,
1522
for example ``['--version']``.
1523
:param env_changes: A dictionary which lists changes to environment
1524
variables. A value of None will unset the env variable.
1525
The values must be strings. The change will only occur in the
1526
child, so you don't need to fix the environment after running.
1527
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1529
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1531
:returns: Popen object for the started process.
1533
if skip_if_plan_to_signal:
1534
if not getattr(os, 'kill', None):
1535
raise TestSkipped("os.kill not available.")
1537
if env_changes is None:
1541
def cleanup_environment():
1542
for env_var, value in env_changes.iteritems():
1543
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1545
def restore_environment():
1546
for env_var, value in old_env.iteritems():
1547
osutils.set_or_unset_env(env_var, value)
1549
bzr_path = self.get_bzr_path()
1552
if working_dir is not None:
1553
cwd = osutils.getcwd()
1554
os.chdir(working_dir)
1557
# win32 subprocess doesn't support preexec_fn
1558
# so we will avoid using it on all platforms, just to
1559
# make sure the code path is used, and we don't break on win32
1560
cleanup_environment()
1561
command = [sys.executable, bzr_path]
1562
if not allow_plugins:
1563
command.append('--no-plugins')
1564
command.extend(process_args)
1565
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1567
restore_environment()
1573
def _popen(self, *args, **kwargs):
1574
"""Place a call to Popen.
1576
Allows tests to override this method to intercept the calls made to
1577
Popen for introspection.
1579
return Popen(*args, **kwargs)
1581
def get_bzr_path(self):
1582
"""Return the path of the 'bzr' executable for this test suite."""
1583
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1584
if not os.path.isfile(bzr_path):
1585
# We are probably installed. Assume sys.argv is the right file
1586
bzr_path = sys.argv[0]
1589
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1590
universal_newlines=False, process_args=None):
1591
"""Finish the execution of process.
1593
:param process: the Popen object returned from start_bzr_subprocess.
1594
:param retcode: The status code that is expected. Defaults to 0. If
1595
None is supplied, the status code is not checked.
1596
:param send_signal: an optional signal to send to the process.
1597
:param universal_newlines: Convert CRLF => LF
1598
:returns: (stdout, stderr)
1600
if send_signal is not None:
1601
os.kill(process.pid, send_signal)
1602
out, err = process.communicate()
1604
if universal_newlines:
1605
out = out.replace('\r\n', '\n')
1606
err = err.replace('\r\n', '\n')
1608
if retcode is not None and retcode != process.returncode:
1609
if process_args is None:
1610
process_args = "(unknown args)"
1611
mutter('Output of bzr %s:\n%s', process_args, out)
1612
mutter('Error for bzr %s:\n%s', process_args, err)
1613
self.fail('Command bzr %s failed with retcode %s != %s'
1614
% (process_args, retcode, process.returncode))
1617
def check_inventory_shape(self, inv, shape):
1618
"""Compare an inventory to a list of expected names.
1620
Fail if they are not precisely equal.
1623
shape = list(shape) # copy
1624
for path, ie in inv.entries():
1625
name = path.replace('\\', '/')
1626
if ie.kind == 'directory':
1633
self.fail("expected paths not found in inventory: %r" % shape)
1635
self.fail("unexpected paths found in inventory: %r" % extras)
1637
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1638
a_callable=None, *args, **kwargs):
1639
"""Call callable with redirected std io pipes.
1641
Returns the return code."""
1642
if not callable(a_callable):
1643
raise ValueError("a_callable must be callable.")
1645
stdin = StringIO("")
1647
if getattr(self, "_log_file", None) is not None:
1648
stdout = self._log_file
1652
if getattr(self, "_log_file", None is not None):
1653
stderr = self._log_file
1656
real_stdin = sys.stdin
1657
real_stdout = sys.stdout
1658
real_stderr = sys.stderr
1663
return a_callable(*args, **kwargs)
1665
sys.stdout = real_stdout
1666
sys.stderr = real_stderr
1667
sys.stdin = real_stdin
1669
def reduceLockdirTimeout(self):
1670
"""Reduce the default lock timeout for the duration of the test, so that
1671
if LockContention occurs during a test, it does so quickly.
1673
Tests that expect to provoke LockContention errors should call this.
1675
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1677
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1678
self.addCleanup(resetTimeout)
1679
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1681
def make_utf8_encoded_stringio(self, encoding_type=None):
1682
"""Return a StringIOWrapper instance, that will encode Unicode
1685
if encoding_type is None:
1686
encoding_type = 'strict'
1688
output_encoding = 'utf-8'
1689
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1690
sio.encoding = output_encoding
1694
class TestCaseWithMemoryTransport(TestCase):
1695
"""Common test class for tests that do not need disk resources.
1697
Tests that need disk resources should derive from TestCaseWithTransport.
1699
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1701
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1702
a directory which does not exist. This serves to help ensure test isolation
1703
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1704
must exist. However, TestCaseWithMemoryTransport does not offer local
1705
file defaults for the transport in tests, nor does it obey the command line
1706
override, so tests that accidentally write to the common directory should
1709
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1710
a .bzr directory that stops us ascending higher into the filesystem.
1716
def __init__(self, methodName='runTest'):
1717
# allow test parameterisation after test construction and before test
1718
# execution. Variables that the parameteriser sets need to be
1719
# ones that are not set by setUp, or setUp will trash them.
1720
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1721
self.vfs_transport_factory = default_transport
1722
self.transport_server = None
1723
self.transport_readonly_server = None
1724
self.__vfs_server = None
1726
def get_transport(self, relpath=None):
1727
"""Return a writeable transport.
1729
This transport is for the test scratch space relative to
1732
:param relpath: a path relative to the base url.
1734
t = get_transport(self.get_url(relpath))
1735
self.assertFalse(t.is_readonly())
1738
def get_readonly_transport(self, relpath=None):
1739
"""Return a readonly transport for the test scratch space
1741
This can be used to test that operations which should only need
1742
readonly access in fact do not try to write.
1744
:param relpath: a path relative to the base url.
1746
t = get_transport(self.get_readonly_url(relpath))
1747
self.assertTrue(t.is_readonly())
1750
def create_transport_readonly_server(self):
1751
"""Create a transport server from class defined at init.
1753
This is mostly a hook for daughter classes.
1755
return self.transport_readonly_server()
1757
def get_readonly_server(self):
1758
"""Get the server instance for the readonly transport
1760
This is useful for some tests with specific servers to do diagnostics.
1762
if self.__readonly_server is None:
1763
if self.transport_readonly_server is None:
1764
# readonly decorator requested
1765
# bring up the server
1766
self.__readonly_server = ReadonlyServer()
1767
self.__readonly_server.setUp(self.get_vfs_only_server())
1769
self.__readonly_server = self.create_transport_readonly_server()
1770
self.__readonly_server.setUp(self.get_vfs_only_server())
1771
self.addCleanup(self.__readonly_server.tearDown)
1772
return self.__readonly_server
1774
def get_readonly_url(self, relpath=None):
1775
"""Get a URL for the readonly transport.
1777
This will either be backed by '.' or a decorator to the transport
1778
used by self.get_url()
1779
relpath provides for clients to get a path relative to the base url.
1780
These should only be downwards relative, not upwards.
1782
base = self.get_readonly_server().get_url()
1783
return self._adjust_url(base, relpath)
1785
def get_vfs_only_server(self):
1786
"""Get the vfs only read/write server instance.
1788
This is useful for some tests with specific servers that need
1791
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1792
is no means to override it.
1794
if self.__vfs_server is None:
1795
self.__vfs_server = MemoryServer()
1796
self.__vfs_server.setUp()
1797
self.addCleanup(self.__vfs_server.tearDown)
1798
return self.__vfs_server
1800
def get_server(self):
1801
"""Get the read/write server instance.
1803
This is useful for some tests with specific servers that need
1806
This is built from the self.transport_server factory. If that is None,
1807
then the self.get_vfs_server is returned.
1809
if self.__server is None:
1810
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1811
return self.get_vfs_only_server()
1813
# bring up a decorated means of access to the vfs only server.
1814
self.__server = self.transport_server()
1816
self.__server.setUp(self.get_vfs_only_server())
1817
except TypeError, e:
1818
# This should never happen; the try:Except here is to assist
1819
# developers having to update code rather than seeing an
1820
# uninformative TypeError.
1821
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1822
self.addCleanup(self.__server.tearDown)
1823
return self.__server
1825
def _adjust_url(self, base, relpath):
1826
"""Get a URL (or maybe a path) for the readwrite transport.
1828
This will either be backed by '.' or to an equivalent non-file based
1830
relpath provides for clients to get a path relative to the base url.
1831
These should only be downwards relative, not upwards.
1833
if relpath is not None and relpath != '.':
1834
if not base.endswith('/'):
1836
# XXX: Really base should be a url; we did after all call
1837
# get_url()! But sometimes it's just a path (from
1838
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1839
# to a non-escaped local path.
1840
if base.startswith('./') or base.startswith('/'):
1843
base += urlutils.escape(relpath)
1846
def get_url(self, relpath=None):
1847
"""Get a URL (or maybe a path) for the readwrite transport.
1849
This will either be backed by '.' or to an equivalent non-file based
1851
relpath provides for clients to get a path relative to the base url.
1852
These should only be downwards relative, not upwards.
1854
base = self.get_server().get_url()
1855
return self._adjust_url(base, relpath)
1857
def get_vfs_only_url(self, relpath=None):
1858
"""Get a URL (or maybe a path for the plain old vfs transport.
1860
This will never be a smart protocol. It always has all the
1861
capabilities of the local filesystem, but it might actually be a
1862
MemoryTransport or some other similar virtual filesystem.
1864
This is the backing transport (if any) of the server returned by
1865
get_url and get_readonly_url.
1867
:param relpath: provides for clients to get a path relative to the base
1868
url. These should only be downwards relative, not upwards.
1871
base = self.get_vfs_only_server().get_url()
1872
return self._adjust_url(base, relpath)
1874
def _create_safety_net(self):
1875
"""Make a fake bzr directory.
1877
This prevents any tests propagating up onto the TEST_ROOT directory's
1880
root = TestCaseWithMemoryTransport.TEST_ROOT
1881
bzrdir.BzrDir.create_standalone_workingtree(root)
1883
def _check_safety_net(self):
1884
"""Check that the safety .bzr directory have not been touched.
1886
_make_test_root have created a .bzr directory to prevent tests from
1887
propagating. This method ensures than a test did not leaked.
1889
root = TestCaseWithMemoryTransport.TEST_ROOT
1890
wt = workingtree.WorkingTree.open(root)
1891
last_rev = wt.last_revision()
1892
if last_rev != 'null:':
1893
# The current test have modified the /bzr directory, we need to
1894
# recreate a new one or all the followng tests will fail.
1895
# If you need to inspect its content uncomment the following line
1896
# import pdb; pdb.set_trace()
1897
_rmtree_temp_dir(root + '/.bzr')
1898
self._create_safety_net()
1899
raise AssertionError('%s/.bzr should not be modified' % root)
1901
def _make_test_root(self):
1902
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1903
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1904
TestCaseWithMemoryTransport.TEST_ROOT = root
1906
self._create_safety_net()
1908
# The same directory is used by all tests, and we're not
1909
# specifically told when all tests are finished. This will do.
1910
atexit.register(_rmtree_temp_dir, root)
1912
self.addCleanup(self._check_safety_net)
1914
def makeAndChdirToTestDir(self):
1915
"""Create a temporary directories for this one test.
1917
This must set self.test_home_dir and self.test_dir and chdir to
1920
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1922
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1923
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1924
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1926
def make_branch(self, relpath, format=None):
1927
"""Create a branch on the transport at relpath."""
1928
repo = self.make_repository(relpath, format=format)
1929
return repo.bzrdir.create_branch()
1931
def make_bzrdir(self, relpath, format=None):
1933
# might be a relative or absolute path
1934
maybe_a_url = self.get_url(relpath)
1935
segments = maybe_a_url.rsplit('/', 1)
1936
t = get_transport(maybe_a_url)
1937
if len(segments) > 1 and segments[-1] not in ('', '.'):
1941
if isinstance(format, basestring):
1942
format = bzrdir.format_registry.make_bzrdir(format)
1943
return format.initialize_on_transport(t)
1944
except errors.UninitializableFormat:
1945
raise TestSkipped("Format %s is not initializable." % format)
1947
def make_repository(self, relpath, shared=False, format=None):
1948
"""Create a repository on our default transport at relpath.
1950
Note that relpath must be a relative path, not a full url.
1952
# FIXME: If you create a remoterepository this returns the underlying
1953
# real format, which is incorrect. Actually we should make sure that
1954
# RemoteBzrDir returns a RemoteRepository.
1955
# maybe mbp 20070410
1956
made_control = self.make_bzrdir(relpath, format=format)
1957
return made_control.create_repository(shared=shared)
1959
def make_branch_and_memory_tree(self, relpath, format=None):
1960
"""Create a branch on the default transport and a MemoryTree for it."""
1961
b = self.make_branch(relpath, format=format)
1962
return memorytree.MemoryTree.create_on_branch(b)
1964
def overrideEnvironmentForTesting(self):
1965
os.environ['HOME'] = self.test_home_dir
1966
os.environ['BZR_HOME'] = self.test_home_dir
1969
super(TestCaseWithMemoryTransport, self).setUp()
1970
self._make_test_root()
1971
_currentdir = os.getcwdu()
1972
def _leaveDirectory():
1973
os.chdir(_currentdir)
1974
self.addCleanup(_leaveDirectory)
1975
self.makeAndChdirToTestDir()
1976
self.overrideEnvironmentForTesting()
1977
self.__readonly_server = None
1978
self.__server = None
1979
self.reduceLockdirTimeout()
1982
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1983
"""Derived class that runs a test within a temporary directory.
1985
This is useful for tests that need to create a branch, etc.
1987
The directory is created in a slightly complex way: for each
1988
Python invocation, a new temporary top-level directory is created.
1989
All test cases create their own directory within that. If the
1990
tests complete successfully, the directory is removed.
1992
:ivar test_base_dir: The path of the top-level directory for this
1993
test, which contains a home directory and a work directory.
1995
:ivar test_home_dir: An initially empty directory under test_base_dir
1996
which is used as $HOME for this test.
1998
:ivar test_dir: A directory under test_base_dir used as the current
1999
directory when the test proper is run.
2002
OVERRIDE_PYTHON = 'python'
2004
def check_file_contents(self, filename, expect):
2005
self.log("check contents of file %s" % filename)
2006
contents = file(filename, 'r').read()
2007
if contents != expect:
2008
self.log("expected: %r" % expect)
2009
self.log("actually: %r" % contents)
2010
self.fail("contents of %s not as expected" % filename)
2012
def makeAndChdirToTestDir(self):
2013
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2015
For TestCaseInTempDir we create a temporary directory based on the test
2016
name and then create two subdirs - test and home under it.
2018
# create a directory within the top level test directory
2019
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2020
# now create test and home directories within this dir
2021
self.test_base_dir = candidate_dir
2022
self.test_home_dir = self.test_base_dir + '/home'
2023
os.mkdir(self.test_home_dir)
2024
self.test_dir = self.test_base_dir + '/work'
2025
os.mkdir(self.test_dir)
2026
os.chdir(self.test_dir)
2027
# put name of test inside
2028
f = file(self.test_base_dir + '/name', 'w')
2033
self.addCleanup(self.deleteTestDir)
2035
def deleteTestDir(self):
2036
os.chdir(self.TEST_ROOT)
2037
_rmtree_temp_dir(self.test_base_dir)
2039
def build_tree(self, shape, line_endings='binary', transport=None):
2040
"""Build a test tree according to a pattern.
2042
shape is a sequence of file specifications. If the final
2043
character is '/', a directory is created.
2045
This assumes that all the elements in the tree being built are new.
2047
This doesn't add anything to a branch.
2049
:param line_endings: Either 'binary' or 'native'
2050
in binary mode, exact contents are written in native mode, the
2051
line endings match the default platform endings.
2052
:param transport: A transport to write to, for building trees on VFS's.
2053
If the transport is readonly or None, "." is opened automatically.
2056
# It's OK to just create them using forward slashes on windows.
2057
if transport is None or transport.is_readonly():
2058
transport = get_transport(".")
2060
self.assert_(isinstance(name, basestring))
2062
transport.mkdir(urlutils.escape(name[:-1]))
2064
if line_endings == 'binary':
2066
elif line_endings == 'native':
2069
raise errors.BzrError(
2070
'Invalid line ending request %r' % line_endings)
2071
content = "contents of %s%s" % (name.encode('utf-8'), end)
2072
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2074
def build_tree_contents(self, shape):
2075
build_tree_contents(shape)
2077
def assertFileEqual(self, content, path):
2078
"""Fail if path does not contain 'content'."""
2079
self.failUnlessExists(path)
2080
f = file(path, 'rb')
2085
self.assertEqualDiff(content, s)
2087
def failUnlessExists(self, path):
2088
"""Fail unless path or paths, which may be abs or relative, exist."""
2089
if not isinstance(path, basestring):
2091
self.failUnlessExists(p)
2093
self.failUnless(osutils.lexists(path),path+" does not exist")
2095
def failIfExists(self, path):
2096
"""Fail if path or paths, which may be abs or relative, exist."""
2097
if not isinstance(path, basestring):
2099
self.failIfExists(p)
2101
self.failIf(osutils.lexists(path),path+" exists")
2103
def assertInWorkingTree(self, path, root_path='.', tree=None):
2104
"""Assert whether path or paths are in the WorkingTree"""
2106
tree = workingtree.WorkingTree.open(root_path)
2107
if not isinstance(path, basestring):
2109
self.assertInWorkingTree(p,tree=tree)
2111
self.assertIsNot(tree.path2id(path), None,
2112
path+' not in working tree.')
2114
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2115
"""Assert whether path or paths are not in the WorkingTree"""
2117
tree = workingtree.WorkingTree.open(root_path)
2118
if not isinstance(path, basestring):
2120
self.assertNotInWorkingTree(p,tree=tree)
2122
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2125
class TestCaseWithTransport(TestCaseInTempDir):
2126
"""A test case that provides get_url and get_readonly_url facilities.
2128
These back onto two transport servers, one for readonly access and one for
2131
If no explicit class is provided for readonly access, a
2132
ReadonlyTransportDecorator is used instead which allows the use of non disk
2133
based read write transports.
2135
If an explicit class is provided for readonly access, that server and the
2136
readwrite one must both define get_url() as resolving to os.getcwd().
2139
def get_vfs_only_server(self):
2140
"""See TestCaseWithMemoryTransport.
2142
This is useful for some tests with specific servers that need
2145
if self.__vfs_server is None:
2146
self.__vfs_server = self.vfs_transport_factory()
2147
self.__vfs_server.setUp()
2148
self.addCleanup(self.__vfs_server.tearDown)
2149
return self.__vfs_server
2151
def make_branch_and_tree(self, relpath, format=None):
2152
"""Create a branch on the transport and a tree locally.
2154
If the transport is not a LocalTransport, the Tree can't be created on
2155
the transport. In that case if the vfs_transport_factory is
2156
LocalURLServer the working tree is created in the local
2157
directory backing the transport, and the returned tree's branch and
2158
repository will also be accessed locally. Otherwise a lightweight
2159
checkout is created and returned.
2161
:param format: The BzrDirFormat.
2162
:returns: the WorkingTree.
2164
# TODO: always use the local disk path for the working tree,
2165
# this obviously requires a format that supports branch references
2166
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2168
b = self.make_branch(relpath, format=format)
2170
return b.bzrdir.create_workingtree()
2171
except errors.NotLocalUrl:
2172
# We can only make working trees locally at the moment. If the
2173
# transport can't support them, then we keep the non-disk-backed
2174
# branch and create a local checkout.
2175
if self.vfs_transport_factory is LocalURLServer:
2176
# the branch is colocated on disk, we cannot create a checkout.
2177
# hopefully callers will expect this.
2178
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2179
return local_controldir.create_workingtree()
2181
return b.create_checkout(relpath, lightweight=True)
2183
def assertIsDirectory(self, relpath, transport):
2184
"""Assert that relpath within transport is a directory.
2186
This may not be possible on all transports; in that case it propagates
2187
a TransportNotPossible.
2190
mode = transport.stat(relpath).st_mode
2191
except errors.NoSuchFile:
2192
self.fail("path %s is not a directory; no such file"
2194
if not stat.S_ISDIR(mode):
2195
self.fail("path %s is not a directory; has mode %#o"
2198
def assertTreesEqual(self, left, right):
2199
"""Check that left and right have the same content and properties."""
2200
# we use a tree delta to check for equality of the content, and we
2201
# manually check for equality of other things such as the parents list.
2202
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2203
differences = left.changes_from(right)
2204
self.assertFalse(differences.has_changed(),
2205
"Trees %r and %r are different: %r" % (left, right, differences))
2208
super(TestCaseWithTransport, self).setUp()
2209
self.__vfs_server = None
2212
class ChrootedTestCase(TestCaseWithTransport):
2213
"""A support class that provides readonly urls outside the local namespace.
2215
This is done by checking if self.transport_server is a MemoryServer. if it
2216
is then we are chrooted already, if it is not then an HttpServer is used
2219
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2220
be used without needed to redo it when a different
2221
subclass is in use ?
2225
super(ChrootedTestCase, self).setUp()
2226
if not self.vfs_transport_factory == MemoryServer:
2227
self.transport_readonly_server = HttpServer
2230
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2231
random_order=False):
2232
"""Create a test suite by filtering another one.
2234
:param suite: the source suite
2235
:param pattern: pattern that names must match
2236
:param exclude_pattern: pattern that names must not match, if any
2237
:param random_order: if True, tests in the new suite will be put in
2239
:returns: the newly created suite
2241
return sort_suite_by_re(suite, pattern, exclude_pattern,
2242
random_order, False)
2245
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2246
random_order=False, append_rest=True):
2247
"""Create a test suite by sorting another one.
2249
:param suite: the source suite
2250
:param pattern: pattern that names must match in order to go
2251
first in the new suite
2252
:param exclude_pattern: pattern that names must not match, if any
2253
:param random_order: if True, tests in the new suite will be put in
2255
:param append_rest: if False, pattern is a strict filter and not
2256
just an ordering directive
2257
:returns: the newly created suite
2261
filter_re = re.compile(pattern)
2262
if exclude_pattern is not None:
2263
exclude_re = re.compile(exclude_pattern)
2264
for test in iter_suite_tests(suite):
2266
if exclude_pattern is None or not exclude_re.search(test_id):
2267
if filter_re.search(test_id):
2272
random.shuffle(first)
2273
random.shuffle(second)
2274
return TestUtil.TestSuite(first + second)
2277
def run_suite(suite, name='test', verbose=False, pattern=".*",
2278
stop_on_failure=False,
2279
transport=None, lsprof_timed=None, bench_history=None,
2280
matching_tests_first=None,
2283
exclude_pattern=None,
2286
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2291
runner = TextTestRunner(stream=sys.stdout,
2293
verbosity=verbosity,
2294
bench_history=bench_history,
2295
list_only=list_only,
2297
runner.stop_on_failure=stop_on_failure
2298
# Initialise the random number generator and display the seed used.
2299
# We convert the seed to a long to make it reuseable across invocations.
2300
random_order = False
2301
if random_seed is not None:
2303
if random_seed == "now":
2304
random_seed = long(time.time())
2306
# Convert the seed to a long if we can
2308
random_seed = long(random_seed)
2311
runner.stream.writeln("Randomizing test order using seed %s\n" %
2313
random.seed(random_seed)
2314
# Customise the list of tests if requested
2315
if pattern != '.*' or exclude_pattern is not None or random_order:
2316
if matching_tests_first:
2317
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2320
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2322
result = runner.run(suite)
2325
return result.wasStrictlySuccessful()
2327
return result.wasSuccessful()
2330
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2332
test_suite_factory=None,
2335
matching_tests_first=None,
2338
exclude_pattern=None,
2341
"""Run the whole test suite under the enhanced runner"""
2342
# XXX: Very ugly way to do this...
2343
# Disable warning about old formats because we don't want it to disturb
2344
# any blackbox tests.
2345
from bzrlib import repository
2346
repository._deprecation_warning_done = True
2348
global default_transport
2349
if transport is None:
2350
transport = default_transport
2351
old_transport = default_transport
2352
default_transport = transport
2354
if test_suite_factory is None:
2355
suite = test_suite()
2357
suite = test_suite_factory()
2358
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2359
stop_on_failure=stop_on_failure,
2360
transport=transport,
2361
lsprof_timed=lsprof_timed,
2362
bench_history=bench_history,
2363
matching_tests_first=matching_tests_first,
2364
list_only=list_only,
2365
random_seed=random_seed,
2366
exclude_pattern=exclude_pattern,
2369
default_transport = old_transport
2373
"""Build and return TestSuite for the whole of bzrlib.
2375
This function can be replaced if you need to change the default test
2376
suite on a global basis, but it is not encouraged.
2379
'bzrlib.util.tests.test_bencode',
2380
'bzrlib.tests.test__dirstate_helpers',
2381
'bzrlib.tests.test_ancestry',
2382
'bzrlib.tests.test_annotate',
2383
'bzrlib.tests.test_api',
2384
'bzrlib.tests.test_atomicfile',
2385
'bzrlib.tests.test_bad_files',
2386
'bzrlib.tests.test_bisect_multi',
2387
'bzrlib.tests.test_branch',
2388
'bzrlib.tests.test_branchbuilder',
2389
'bzrlib.tests.test_bugtracker',
2390
'bzrlib.tests.test_bundle',
2391
'bzrlib.tests.test_bzrdir',
2392
'bzrlib.tests.test_cache_utf8',
2393
'bzrlib.tests.test_commands',
2394
'bzrlib.tests.test_commit',
2395
'bzrlib.tests.test_commit_merge',
2396
'bzrlib.tests.test_config',
2397
'bzrlib.tests.test_conflicts',
2398
'bzrlib.tests.test_counted_lock',
2399
'bzrlib.tests.test_decorators',
2400
'bzrlib.tests.test_delta',
2401
'bzrlib.tests.test_deprecated_graph',
2402
'bzrlib.tests.test_diff',
2403
'bzrlib.tests.test_dirstate',
2404
'bzrlib.tests.test_email_message',
2405
'bzrlib.tests.test_errors',
2406
'bzrlib.tests.test_escaped_store',
2407
'bzrlib.tests.test_extract',
2408
'bzrlib.tests.test_fetch',
2409
'bzrlib.tests.test_ftp_transport',
2410
'bzrlib.tests.test_generate_docs',
2411
'bzrlib.tests.test_generate_ids',
2412
'bzrlib.tests.test_globbing',
2413
'bzrlib.tests.test_gpg',
2414
'bzrlib.tests.test_graph',
2415
'bzrlib.tests.test_hashcache',
2416
'bzrlib.tests.test_help',
2417
'bzrlib.tests.test_hooks',
2418
'bzrlib.tests.test_http',
2419
'bzrlib.tests.test_http_response',
2420
'bzrlib.tests.test_https_ca_bundle',
2421
'bzrlib.tests.test_identitymap',
2422
'bzrlib.tests.test_ignores',
2423
'bzrlib.tests.test_index',
2424
'bzrlib.tests.test_info',
2425
'bzrlib.tests.test_inv',
2426
'bzrlib.tests.test_knit',
2427
'bzrlib.tests.test_lazy_import',
2428
'bzrlib.tests.test_lazy_regex',
2429
'bzrlib.tests.test_lockdir',
2430
'bzrlib.tests.test_lockable_files',
2431
'bzrlib.tests.test_log',
2432
'bzrlib.tests.test_lsprof',
2433
'bzrlib.tests.test_lru_cache',
2434
'bzrlib.tests.test_mail_client',
2435
'bzrlib.tests.test_memorytree',
2436
'bzrlib.tests.test_merge',
2437
'bzrlib.tests.test_merge3',
2438
'bzrlib.tests.test_merge_core',
2439
'bzrlib.tests.test_merge_directive',
2440
'bzrlib.tests.test_missing',
2441
'bzrlib.tests.test_msgeditor',
2442
'bzrlib.tests.test_multiparent',
2443
'bzrlib.tests.test_nonascii',
2444
'bzrlib.tests.test_options',
2445
'bzrlib.tests.test_osutils',
2446
'bzrlib.tests.test_osutils_encodings',
2447
'bzrlib.tests.test_pack',
2448
'bzrlib.tests.test_patch',
2449
'bzrlib.tests.test_patches',
2450
'bzrlib.tests.test_permissions',
2451
'bzrlib.tests.test_plugins',
2452
'bzrlib.tests.test_progress',
2453
'bzrlib.tests.test_reconfigure',
2454
'bzrlib.tests.test_reconcile',
2455
'bzrlib.tests.test_registry',
2456
'bzrlib.tests.test_remote',
2457
'bzrlib.tests.test_repository',
2458
'bzrlib.tests.test_revert',
2459
'bzrlib.tests.test_revision',
2460
'bzrlib.tests.test_revisionnamespaces',
2461
'bzrlib.tests.test_revisiontree',
2462
'bzrlib.tests.test_rio',
2463
'bzrlib.tests.test_sampler',
2464
'bzrlib.tests.test_selftest',
2465
'bzrlib.tests.test_setup',
2466
'bzrlib.tests.test_sftp_transport',
2467
'bzrlib.tests.test_smart',
2468
'bzrlib.tests.test_smart_add',
2469
'bzrlib.tests.test_smart_transport',
2470
'bzrlib.tests.test_smtp_connection',
2471
'bzrlib.tests.test_source',
2472
'bzrlib.tests.test_ssh_transport',
2473
'bzrlib.tests.test_status',
2474
'bzrlib.tests.test_store',
2475
'bzrlib.tests.test_strace',
2476
'bzrlib.tests.test_subsume',
2477
'bzrlib.tests.test_switch',
2478
'bzrlib.tests.test_symbol_versioning',
2479
'bzrlib.tests.test_tag',
2480
'bzrlib.tests.test_testament',
2481
'bzrlib.tests.test_textfile',
2482
'bzrlib.tests.test_textmerge',
2483
'bzrlib.tests.test_timestamp',
2484
'bzrlib.tests.test_trace',
2485
'bzrlib.tests.test_transactions',
2486
'bzrlib.tests.test_transform',
2487
'bzrlib.tests.test_transport',
2488
'bzrlib.tests.test_tree',
2489
'bzrlib.tests.test_treebuilder',
2490
'bzrlib.tests.test_tsort',
2491
'bzrlib.tests.test_tuned_gzip',
2492
'bzrlib.tests.test_ui',
2493
'bzrlib.tests.test_upgrade',
2494
'bzrlib.tests.test_urlutils',
2495
'bzrlib.tests.test_versionedfile',
2496
'bzrlib.tests.test_version',
2497
'bzrlib.tests.test_version_info',
2498
'bzrlib.tests.test_weave',
2499
'bzrlib.tests.test_whitebox',
2500
'bzrlib.tests.test_win32utils',
2501
'bzrlib.tests.test_workingtree',
2502
'bzrlib.tests.test_workingtree_4',
2503
'bzrlib.tests.test_wsgi',
2504
'bzrlib.tests.test_xml',
2506
test_transport_implementations = [
2507
'bzrlib.tests.test_transport_implementations',
2508
'bzrlib.tests.test_read_bundle',
2510
suite = TestUtil.TestSuite()
2511
loader = TestUtil.TestLoader()
2512
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2513
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2514
adapter = TransportTestProviderAdapter()
2515
adapt_modules(test_transport_implementations, adapter, loader, suite)
2517
["bzrlib.tests.test_msgeditor.MsgEditorTest."
2518
"test__create_temp_file_with_commit_template_in_unicode_dir"],
2519
EncodingTestAdapter(), loader, suite)
2520
for package in packages_to_test():
2521
suite.addTest(package.test_suite())
2522
for m in MODULES_TO_TEST:
2523
suite.addTest(loader.loadTestsFromModule(m))
2524
for m in MODULES_TO_DOCTEST:
2526
suite.addTest(doctest.DocTestSuite(m))
2527
except ValueError, e:
2528
print '**failed to get doctest for: %s\n%s' %(m,e)
2530
default_encoding = sys.getdefaultencoding()
2531
for name, plugin in bzrlib.plugin.plugins().items():
2533
plugin_suite = plugin.test_suite()
2534
except ImportError, e:
2535
bzrlib.trace.warning(
2536
'Unable to test plugin "%s": %s', name, e)
2538
if plugin_suite is not None:
2539
suite.addTest(plugin_suite)
2540
if default_encoding != sys.getdefaultencoding():
2541
bzrlib.trace.warning(
2542
'Plugin "%s" tried to reset default encoding to: %s', name,
2543
sys.getdefaultencoding())
2545
sys.setdefaultencoding(default_encoding)
2549
def multiply_tests_from_modules(module_name_list, scenario_iter):
2550
"""Adapt all tests in some given modules to given scenarios.
2552
This is the recommended public interface for test parameterization.
2553
Typically the test_suite() method for a per-implementation test
2554
suite will call multiply_tests_from_modules and return the
2557
:param module_name_list: List of fully-qualified names of test
2559
:param scenario_iter: Iterable of pairs of (scenario_name,
2560
scenario_param_dict).
2562
This returns a new TestSuite containing the cross product of
2563
all the tests in all the modules, each repeated for each scenario.
2564
Each test is adapted by adding the scenario name at the end
2565
of its name, and updating the test object's __dict__ with the
2566
scenario_param_dict.
2568
>>> r = multiply_tests_from_modules(
2569
... ['bzrlib.tests.test_sampler'],
2570
... [('one', dict(param=1)),
2571
... ('two', dict(param=2))])
2572
>>> tests = list(iter_suite_tests(r))
2576
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2582
loader = TestLoader()
2584
adapter = TestScenarioApplier()
2585
adapter.scenarios = list(scenario_iter)
2586
adapt_modules(module_name_list, adapter, loader, suite)
2590
def multiply_scenarios(scenarios_left, scenarios_right):
2591
"""Multiply two sets of scenarios.
2593
:returns: the cartesian product of the two sets of scenarios, that is
2594
a scenario for every possible combination of a left scenario and a
2598
('%s,%s' % (left_name, right_name),
2599
dict(left_dict.items() + right_dict.items()))
2600
for left_name, left_dict in scenarios_left
2601
for right_name, right_dict in scenarios_right]
2605
def adapt_modules(mods_list, adapter, loader, suite):
2606
"""Adapt the modules in mods_list using adapter and add to suite."""
2607
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2608
suite.addTests(adapter.adapt(test))
2611
def adapt_tests(tests_list, adapter, loader, suite):
2612
"""Adapt the tests in tests_list using adapter and add to suite."""
2613
for test in tests_list:
2614
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2617
def _rmtree_temp_dir(dirname):
2618
# If LANG=C we probably have created some bogus paths
2619
# which rmtree(unicode) will fail to delete
2620
# so make sure we are using rmtree(str) to delete everything
2621
# except on win32, where rmtree(str) will fail
2622
# since it doesn't have the property of byte-stream paths
2623
# (they are either ascii or mbcs)
2624
if sys.platform == 'win32':
2625
# make sure we are using the unicode win32 api
2626
dirname = unicode(dirname)
2628
dirname = dirname.encode(sys.getfilesystemencoding())
2630
osutils.rmtree(dirname)
2632
if sys.platform == 'win32' and e.errno == errno.EACCES:
2633
sys.stderr.write(('Permission denied: '
2634
'unable to remove testing dir '
2635
'%s\n' % os.path.basename(dirname)))
2640
class Feature(object):
2641
"""An operating system Feature."""
2644
self._available = None
2646
def available(self):
2647
"""Is the feature available?
2649
:return: True if the feature is available.
2651
if self._available is None:
2652
self._available = self._probe()
2653
return self._available
2656
"""Implement this method in concrete features.
2658
:return: True if the feature is available.
2660
raise NotImplementedError
2663
if getattr(self, 'feature_name', None):
2664
return self.feature_name()
2665
return self.__class__.__name__
2668
class _SymlinkFeature(Feature):
2671
return osutils.has_symlinks()
2673
def feature_name(self):
2676
SymlinkFeature = _SymlinkFeature()
2679
class _OsFifoFeature(Feature):
2682
return getattr(os, 'mkfifo', None)
2684
def feature_name(self):
2685
return 'filesystem fifos'
2687
OsFifoFeature = _OsFifoFeature()
2690
class TestScenarioApplier(object):
2691
"""A tool to apply scenarios to tests."""
2693
def adapt(self, test):
2694
"""Return a TestSuite containing a copy of test for each scenario."""
2695
result = unittest.TestSuite()
2696
for scenario in self.scenarios:
2697
result.addTest(self.adapt_test_to_scenario(test, scenario))
2700
def adapt_test_to_scenario(self, test, scenario):
2701
"""Copy test and apply scenario to it.
2703
:param test: A test to adapt.
2704
:param scenario: A tuple describing the scenarion.
2705
The first element of the tuple is the new test id.
2706
The second element is a dict containing attributes to set on the
2708
:return: The adapted test.
2710
from copy import deepcopy
2711
new_test = deepcopy(test)
2712
for name, value in scenario[1].items():
2713
setattr(new_test, name, value)
2714
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2715
new_test.id = lambda: new_id
2719
def probe_unicode_in_user_encoding():
2720
"""Try to encode several unicode strings to use in unicode-aware tests.
2721
Return first successfull match.
2723
:return: (unicode value, encoded plain string value) or (None, None)
2725
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2726
for uni_val in possible_vals:
2728
str_val = uni_val.encode(bzrlib.user_encoding)
2729
except UnicodeEncodeError:
2730
# Try a different character
2733
return uni_val, str_val
2737
def probe_bad_non_ascii(encoding):
2738
"""Try to find [bad] character with code [128..255]
2739
that cannot be decoded to unicode in some encoding.
2740
Return None if all non-ascii characters is valid
2743
for i in xrange(128, 256):
2746
char.decode(encoding)
2747
except UnicodeDecodeError:
2752
class _FTPServerFeature(Feature):
2753
"""Some tests want an FTP Server, check if one is available.
2755
Right now, the only way this is available is if 'medusa' is installed.
2756
http://www.amk.ca/python/code/medusa.html
2761
import bzrlib.tests.ftp_server
2766
def feature_name(self):
2769
FTPServerFeature = _FTPServerFeature()
added
removed
bzrlib/tests/__init__.py
