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.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
118
# quoted to avoid module-loading circularity
123
def packages_to_test():
124
"""Return a list of packages to test.
126
The packages are not globally imported so that import failures are
127
triggered when running selftest, not when importing the command.
130
import bzrlib.tests.blackbox
131
import bzrlib.tests.branch_implementations
132
import bzrlib.tests.bzrdir_implementations
133
import bzrlib.tests.commands
134
import bzrlib.tests.interrepository_implementations
135
import bzrlib.tests.interversionedfile_implementations
136
import bzrlib.tests.intertree_implementations
137
import bzrlib.tests.inventory_implementations
138
import bzrlib.tests.per_lock
139
import bzrlib.tests.repository_implementations
140
import bzrlib.tests.revisionstore_implementations
141
import bzrlib.tests.tree_implementations
142
import bzrlib.tests.workingtree_implementations
145
bzrlib.tests.blackbox,
146
bzrlib.tests.branch_implementations,
147
bzrlib.tests.bzrdir_implementations,
148
bzrlib.tests.commands,
149
bzrlib.tests.interrepository_implementations,
150
bzrlib.tests.interversionedfile_implementations,
151
bzrlib.tests.intertree_implementations,
152
bzrlib.tests.inventory_implementations,
153
bzrlib.tests.per_lock,
154
bzrlib.tests.repository_implementations,
155
bzrlib.tests.revisionstore_implementations,
156
bzrlib.tests.tree_implementations,
157
bzrlib.tests.workingtree_implementations,
161
class ExtendedTestResult(unittest._TextTestResult):
162
"""Accepts, reports and accumulates the results of running tests.
164
Compared to the unittest version this class adds support for
165
profiling, benchmarking, stopping as soon as a test fails, and
166
skipping tests. There are further-specialized subclasses for
167
different types of display.
169
When a test finishes, in whatever way, it calls one of the addSuccess,
170
addFailure or addError classes. These in turn may redirect to a more
171
specific case for the special test results supported by our extended
174
Note that just one of these objects is fed the results from many tests.
179
def __init__(self, stream, descriptions, verbosity,
183
"""Construct new TestResult.
185
:param bench_history: Optionally, a writable file object to accumulate
188
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
189
if bench_history is not None:
190
from bzrlib.version import _get_bzr_source_tree
191
src_tree = _get_bzr_source_tree()
194
revision_id = src_tree.get_parent_ids()[0]
196
# XXX: if this is a brand new tree, do the same as if there
200
# XXX: If there's no branch, what should we do?
202
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
203
self._bench_history = bench_history
204
self.ui = ui.ui_factory
205
self.num_tests = num_tests
207
self.failure_count = 0
208
self.known_failure_count = 0
210
self.not_applicable_count = 0
211
self.unsupported = {}
213
self._overall_start_time = time.time()
215
def _extractBenchmarkTime(self, testCase):
216
"""Add a benchmark time for the current test case."""
217
return getattr(testCase, "_benchtime", None)
219
def _elapsedTestTimeString(self):
220
"""Return a time string for the overall time the current test has taken."""
221
return self._formatTime(time.time() - self._start_time)
223
def _testTimeString(self, testCase):
224
benchmark_time = self._extractBenchmarkTime(testCase)
225
if benchmark_time is not None:
227
self._formatTime(benchmark_time),
228
self._elapsedTestTimeString())
230
return " %s" % self._elapsedTestTimeString()
232
def _formatTime(self, seconds):
233
"""Format seconds as milliseconds with leading spaces."""
234
# some benchmarks can take thousands of seconds to run, so we need 8
236
return "%8dms" % (1000 * seconds)
238
def _shortened_test_description(self, test):
240
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
243
def startTest(self, test):
244
unittest.TestResult.startTest(self, test)
245
self.report_test_start(test)
246
test.number = self.count
247
self._recordTestStartTime()
249
def _recordTestStartTime(self):
250
"""Record that a test has started."""
251
self._start_time = time.time()
253
def _cleanupLogFile(self, test):
254
# We can only do this if we have one of our TestCases, not if
256
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
257
if setKeepLogfile is not None:
260
def addError(self, test, err):
261
"""Tell result that test finished with an error.
263
Called from the TestCase run() method when the test
264
fails with an unexpected error.
266
self._testConcluded(test)
267
if isinstance(err[1], TestSkipped):
268
return self._addSkipped(test, err)
269
elif isinstance(err[1], UnavailableFeature):
270
return self.addNotSupported(test, err[1].args[0])
272
unittest.TestResult.addError(self, test, err)
273
self.error_count += 1
274
self.report_error(test, err)
278
def addFailure(self, test, err):
279
"""Tell result that test failed.
281
Called from the TestCase run() method when the test
282
fails because e.g. an assert() method failed.
284
self._testConcluded(test)
285
if isinstance(err[1], KnownFailure):
286
return self._addKnownFailure(test, err)
288
unittest.TestResult.addFailure(self, test, err)
289
self.failure_count += 1
290
self.report_failure(test, err)
294
def addSuccess(self, test):
295
"""Tell result that test completed successfully.
297
Called from the TestCase run()
299
self._testConcluded(test)
300
if self._bench_history is not None:
301
benchmark_time = self._extractBenchmarkTime(test)
302
if benchmark_time is not None:
303
self._bench_history.write("%s %s\n" % (
304
self._formatTime(benchmark_time),
306
self.report_success(test)
307
unittest.TestResult.addSuccess(self, test)
309
def _testConcluded(self, test):
310
"""Common code when a test has finished.
312
Called regardless of whether it succeded, failed, etc.
314
self._cleanupLogFile(test)
316
def _addKnownFailure(self, test, err):
317
self.known_failure_count += 1
318
self.report_known_failure(test, err)
320
def addNotSupported(self, test, feature):
321
"""The test will not be run because of a missing feature.
323
# this can be called in two different ways: it may be that the
324
# test started running, and then raised (through addError)
325
# UnavailableFeature. Alternatively this method can be called
326
# while probing for features before running the tests; in that
327
# case we will see startTest and stopTest, but the test will never
329
self.unsupported.setdefault(str(feature), 0)
330
self.unsupported[str(feature)] += 1
331
self.report_unsupported(test, feature)
333
def _addSkipped(self, test, skip_excinfo):
334
if isinstance(skip_excinfo[1], TestNotApplicable):
335
self.not_applicable_count += 1
336
self.report_not_applicable(test, skip_excinfo)
339
self.report_skip(test, skip_excinfo)
342
except KeyboardInterrupt:
345
self.addError(test, test._exc_info())
347
# seems best to treat this as success from point-of-view of unittest
348
# -- it actually does nothing so it barely matters :)
349
unittest.TestResult.addSuccess(self, test)
351
def printErrorList(self, flavour, errors):
352
for test, err in errors:
353
self.stream.writeln(self.separator1)
354
self.stream.write("%s: " % flavour)
355
self.stream.writeln(self.getDescription(test))
356
if getattr(test, '_get_log', None) is not None:
358
print >>self.stream, \
359
('vvvv[log from %s]' % test.id()).ljust(78,'-')
360
print >>self.stream, test._get_log()
361
print >>self.stream, \
362
('^^^^[log from %s]' % test.id()).ljust(78,'-')
363
self.stream.writeln(self.separator2)
364
self.stream.writeln("%s" % err)
369
def report_cleaning_up(self):
372
def report_success(self, test):
375
def wasStrictlySuccessful(self):
376
if self.unsupported or self.known_failure_count:
378
return self.wasSuccessful()
381
class TextTestResult(ExtendedTestResult):
382
"""Displays progress and results of tests in text form"""
384
def __init__(self, stream, descriptions, verbosity,
389
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
390
bench_history, num_tests)
392
self.pb = self.ui.nested_progress_bar()
393
self._supplied_pb = False
396
self._supplied_pb = True
397
self.pb.show_pct = False
398
self.pb.show_spinner = False
399
self.pb.show_eta = False,
400
self.pb.show_count = False
401
self.pb.show_bar = False
403
def report_starting(self):
404
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
406
def _progress_prefix_text(self):
407
a = '[%d' % self.count
408
if self.num_tests is not None:
409
a +='/%d' % self.num_tests
410
a += ' in %ds' % (time.time() - self._overall_start_time)
412
a += ', %d errors' % self.error_count
413
if self.failure_count:
414
a += ', %d failed' % self.failure_count
415
if self.known_failure_count:
416
a += ', %d known failures' % self.known_failure_count
418
a += ', %d skipped' % self.skip_count
420
a += ', %d missing features' % len(self.unsupported)
424
def report_test_start(self, test):
427
self._progress_prefix_text()
429
+ self._shortened_test_description(test))
431
def _test_description(self, test):
432
return self._shortened_test_description(test)
434
def report_error(self, test, err):
435
self.pb.note('ERROR: %s\n %s\n',
436
self._test_description(test),
440
def report_failure(self, test, err):
441
self.pb.note('FAIL: %s\n %s\n',
442
self._test_description(test),
446
def report_known_failure(self, test, err):
447
self.pb.note('XFAIL: %s\n%s\n',
448
self._test_description(test), err[1])
450
def report_skip(self, test, skip_excinfo):
453
def report_not_applicable(self, test, skip_excinfo):
456
def report_unsupported(self, test, feature):
457
"""test cannot be run because feature is missing."""
459
def report_cleaning_up(self):
460
self.pb.update('cleaning up...')
463
if not self._supplied_pb:
467
class VerboseTestResult(ExtendedTestResult):
468
"""Produce long output, with one line per test run plus times"""
470
def _ellipsize_to_right(self, a_string, final_width):
471
"""Truncate and pad a string, keeping the right hand side"""
472
if len(a_string) > final_width:
473
result = '...' + a_string[3-final_width:]
476
return result.ljust(final_width)
478
def report_starting(self):
479
self.stream.write('running %d tests...\n' % self.num_tests)
481
def report_test_start(self, test):
483
name = self._shortened_test_description(test)
484
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
485
# numbers, plus a trailing blank
486
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
487
self.stream.write(self._ellipsize_to_right(name,
488
osutils.terminal_width()-30))
491
def _error_summary(self, err):
493
return '%s%s' % (indent, err[1])
495
def report_error(self, test, err):
496
self.stream.writeln('ERROR %s\n%s'
497
% (self._testTimeString(test),
498
self._error_summary(err)))
500
def report_failure(self, test, err):
501
self.stream.writeln(' FAIL %s\n%s'
502
% (self._testTimeString(test),
503
self._error_summary(err)))
505
def report_known_failure(self, test, err):
506
self.stream.writeln('XFAIL %s\n%s'
507
% (self._testTimeString(test),
508
self._error_summary(err)))
510
def report_success(self, test):
511
self.stream.writeln(' OK %s' % self._testTimeString(test))
512
for bench_called, stats in getattr(test, '_benchcalls', []):
513
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
514
stats.pprint(file=self.stream)
515
# flush the stream so that we get smooth output. This verbose mode is
516
# used to show the output in PQM.
519
def report_skip(self, test, skip_excinfo):
520
self.stream.writeln(' SKIP %s\n%s'
521
% (self._testTimeString(test),
522
self._error_summary(skip_excinfo)))
524
def report_not_applicable(self, test, skip_excinfo):
525
self.stream.writeln(' N/A %s\n%s'
526
% (self._testTimeString(test),
527
self._error_summary(skip_excinfo)))
529
def report_unsupported(self, test, feature):
530
"""test cannot be run because feature is missing."""
531
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
532
%(self._testTimeString(test), feature))
535
class TextTestRunner(object):
536
stop_on_failure = False
545
self.stream = unittest._WritelnDecorator(stream)
546
self.descriptions = descriptions
547
self.verbosity = verbosity
548
self._bench_history = bench_history
549
self.list_only = list_only
552
"Run the given test case or test suite."
553
startTime = time.time()
554
if self.verbosity == 1:
555
result_class = TextTestResult
556
elif self.verbosity >= 2:
557
result_class = VerboseTestResult
558
result = result_class(self.stream,
561
bench_history=self._bench_history,
562
num_tests=test.countTestCases(),
564
result.stop_early = self.stop_on_failure
565
result.report_starting()
567
if self.verbosity >= 2:
568
self.stream.writeln("Listing tests only ...\n")
570
for t in iter_suite_tests(test):
571
self.stream.writeln("%s" % (t.id()))
573
actionTaken = "Listed"
576
run = result.testsRun
578
stopTime = time.time()
579
timeTaken = stopTime - startTime
581
self.stream.writeln(result.separator2)
582
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
583
run, run != 1 and "s" or "", timeTaken))
584
self.stream.writeln()
585
if not result.wasSuccessful():
586
self.stream.write("FAILED (")
587
failed, errored = map(len, (result.failures, result.errors))
589
self.stream.write("failures=%d" % failed)
591
if failed: self.stream.write(", ")
592
self.stream.write("errors=%d" % errored)
593
if result.known_failure_count:
594
if failed or errored: self.stream.write(", ")
595
self.stream.write("known_failure_count=%d" %
596
result.known_failure_count)
597
self.stream.writeln(")")
599
if result.known_failure_count:
600
self.stream.writeln("OK (known_failures=%d)" %
601
result.known_failure_count)
603
self.stream.writeln("OK")
604
if result.skip_count > 0:
605
skipped = result.skip_count
606
self.stream.writeln('%d test%s skipped' %
607
(skipped, skipped != 1 and "s" or ""))
608
if result.unsupported:
609
for feature, count in sorted(result.unsupported.items()):
610
self.stream.writeln("Missing feature '%s' skipped %d tests." %
616
def iter_suite_tests(suite):
617
"""Return all tests in a suite, recursing through nested suites"""
618
for item in suite._tests:
619
if isinstance(item, unittest.TestCase):
621
elif isinstance(item, unittest.TestSuite):
622
for r in iter_suite_tests(item):
625
raise Exception('unknown object %r inside test suite %r'
629
class TestSkipped(Exception):
630
"""Indicates that a test was intentionally skipped, rather than failing."""
633
class TestNotApplicable(TestSkipped):
634
"""A test is not applicable to the situation where it was run.
636
This is only normally raised by parameterized tests, if they find that
637
the instance they're constructed upon does not support one aspect
642
class KnownFailure(AssertionError):
643
"""Indicates that a test failed in a precisely expected manner.
645
Such failures dont block the whole test suite from passing because they are
646
indicators of partially completed code or of future work. We have an
647
explicit error for them so that we can ensure that they are always visible:
648
KnownFailures are always shown in the output of bzr selftest.
652
class UnavailableFeature(Exception):
653
"""A feature required for this test was not available.
655
The feature should be used to construct the exception.
659
class CommandFailed(Exception):
663
class StringIOWrapper(object):
664
"""A wrapper around cStringIO which just adds an encoding attribute.
666
Internally we can check sys.stdout to see what the output encoding
667
should be. However, cStringIO has no encoding attribute that we can
668
set. So we wrap it instead.
673
def __init__(self, s=None):
675
self.__dict__['_cstring'] = StringIO(s)
677
self.__dict__['_cstring'] = StringIO()
679
def __getattr__(self, name, getattr=getattr):
680
return getattr(self.__dict__['_cstring'], name)
682
def __setattr__(self, name, val):
683
if name == 'encoding':
684
self.__dict__['encoding'] = val
686
return setattr(self._cstring, name, val)
689
class TestUIFactory(ui.CLIUIFactory):
690
"""A UI Factory for testing.
692
Hide the progress bar but emit note()s.
694
Allows get_password to be tested without real tty attached.
701
super(TestUIFactory, self).__init__()
702
if stdin is not None:
703
# We use a StringIOWrapper to be able to test various
704
# encodings, but the user is still responsible to
705
# encode the string and to set the encoding attribute
706
# of StringIOWrapper.
707
self.stdin = StringIOWrapper(stdin)
709
self.stdout = sys.stdout
713
self.stderr = sys.stderr
718
"""See progress.ProgressBar.clear()."""
720
def clear_term(self):
721
"""See progress.ProgressBar.clear_term()."""
723
def clear_term(self):
724
"""See progress.ProgressBar.clear_term()."""
727
"""See progress.ProgressBar.finished()."""
729
def note(self, fmt_string, *args, **kwargs):
730
"""See progress.ProgressBar.note()."""
731
self.stdout.write((fmt_string + "\n") % args)
733
def progress_bar(self):
736
def nested_progress_bar(self):
739
def update(self, message, count=None, total=None):
740
"""See progress.ProgressBar.update()."""
742
def get_non_echoed_password(self, prompt):
743
"""Get password from stdin without trying to handle the echo mode"""
745
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
746
password = self.stdin.readline()
749
if password[-1] == '\n':
750
password = password[:-1]
754
class TestCase(unittest.TestCase):
755
"""Base class for bzr unit tests.
757
Tests that need access to disk resources should subclass
758
TestCaseInTempDir not TestCase.
760
Error and debug log messages are redirected from their usual
761
location into a temporary file, the contents of which can be
762
retrieved by _get_log(). We use a real OS file, not an in-memory object,
763
so that it can also capture file IO. When the test completes this file
764
is read into memory and removed from disk.
766
There are also convenience functions to invoke bzr's command-line
767
routine, and to build and check bzr trees.
769
In addition to the usual method of overriding tearDown(), this class also
770
allows subclasses to register functions into the _cleanups list, which is
771
run in order as the object is torn down. It's less likely this will be
772
accidentally overlooked.
775
_log_file_name = None
777
_keep_log_file = False
778
# record lsprof data when performing benchmark calls.
779
_gather_lsprof_in_benchmarks = False
781
def __init__(self, methodName='testMethod'):
782
super(TestCase, self).__init__(methodName)
786
unittest.TestCase.setUp(self)
787
self._cleanEnvironment()
788
bzrlib.trace.disable_default_logging()
791
self._benchcalls = []
792
self._benchtime = None
794
self._clear_debug_flags()
796
def _clear_debug_flags(self):
797
"""Prevent externally set debug flags affecting tests.
799
Tests that want to use debug flags can just set them in the
800
debug_flags set during setup/teardown.
802
self._preserved_debug_flags = set(debug.debug_flags)
803
debug.debug_flags.clear()
804
self.addCleanup(self._restore_debug_flags)
806
def _clear_hooks(self):
807
# prevent hooks affecting tests
809
import bzrlib.smart.server
810
self._preserved_hooks = {
811
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
812
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
814
self.addCleanup(self._restoreHooks)
815
# reset all hooks to an empty instance of the appropriate type
816
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
817
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
819
def _silenceUI(self):
820
"""Turn off UI for duration of test"""
821
# by default the UI is off; tests can turn it on if they want it.
822
saved = ui.ui_factory
824
ui.ui_factory = saved
825
ui.ui_factory = ui.SilentUIFactory()
826
self.addCleanup(_restore)
828
def _ndiff_strings(self, a, b):
829
"""Return ndiff between two strings containing lines.
831
A trailing newline is added if missing to make the strings
833
if b and b[-1] != '\n':
835
if a and a[-1] != '\n':
837
difflines = difflib.ndiff(a.splitlines(True),
839
linejunk=lambda x: False,
840
charjunk=lambda x: False)
841
return ''.join(difflines)
843
def assertEqual(self, a, b, message=''):
847
except UnicodeError, e:
848
# If we can't compare without getting a UnicodeError, then
849
# obviously they are different
850
mutter('UnicodeError: %s', e)
853
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
855
pformat(a), pformat(b)))
857
assertEquals = assertEqual
859
def assertEqualDiff(self, a, b, message=None):
860
"""Assert two texts are equal, if not raise an exception.
862
This is intended for use with multi-line strings where it can
863
be hard to find the differences by eye.
865
# TODO: perhaps override assertEquals to call this for strings?
869
message = "texts not equal:\n"
870
raise AssertionError(message +
871
self._ndiff_strings(a, b))
873
def assertEqualMode(self, mode, mode_test):
874
self.assertEqual(mode, mode_test,
875
'mode mismatch %o != %o' % (mode, mode_test))
877
def assertPositive(self, val):
878
"""Assert that val is greater than 0."""
879
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
881
def assertNegative(self, val):
882
"""Assert that val is less than 0."""
883
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
885
def assertStartsWith(self, s, prefix):
886
if not s.startswith(prefix):
887
raise AssertionError('string %r does not start with %r' % (s, prefix))
889
def assertEndsWith(self, s, suffix):
890
"""Asserts that s ends with suffix."""
891
if not s.endswith(suffix):
892
raise AssertionError('string %r does not end with %r' % (s, suffix))
894
def assertContainsRe(self, haystack, needle_re):
895
"""Assert that a contains something matching a regular expression."""
896
if not re.search(needle_re, haystack):
897
if '\n' in haystack or len(haystack) > 60:
898
# a long string, format it in a more readable way
899
raise AssertionError(
900
'pattern "%s" not found in\n"""\\\n%s"""\n'
901
% (needle_re, haystack))
903
raise AssertionError('pattern "%s" not found in "%s"'
904
% (needle_re, haystack))
906
def assertNotContainsRe(self, haystack, needle_re):
907
"""Assert that a does not match a regular expression"""
908
if re.search(needle_re, haystack):
909
raise AssertionError('pattern "%s" found in "%s"'
910
% (needle_re, haystack))
912
def assertSubset(self, sublist, superlist):
913
"""Assert that every entry in sublist is present in superlist."""
914
missing = set(sublist) - set(superlist)
916
raise AssertionError("value(s) %r not present in container %r" %
917
(missing, superlist))
919
def assertListRaises(self, excClass, func, *args, **kwargs):
920
"""Fail unless excClass is raised when the iterator from func is used.
922
Many functions can return generators this makes sure
923
to wrap them in a list() call to make sure the whole generator
924
is run, and that the proper exception is raised.
927
list(func(*args, **kwargs))
931
if getattr(excClass,'__name__', None) is not None:
932
excName = excClass.__name__
934
excName = str(excClass)
935
raise self.failureException, "%s not raised" % excName
937
def assertRaises(self, excClass, callableObj, *args, **kwargs):
938
"""Assert that a callable raises a particular exception.
940
:param excClass: As for the except statement, this may be either an
941
exception class, or a tuple of classes.
942
:param callableObj: A callable, will be passed ``*args`` and
945
Returns the exception so that you can examine it.
948
callableObj(*args, **kwargs)
952
if getattr(excClass,'__name__', None) is not None:
953
excName = excClass.__name__
956
excName = str(excClass)
957
raise self.failureException, "%s not raised" % excName
959
def assertIs(self, left, right, message=None):
960
if not (left is right):
961
if message is not None:
962
raise AssertionError(message)
964
raise AssertionError("%r is not %r." % (left, right))
966
def assertIsNot(self, left, right, message=None):
968
if message is not None:
969
raise AssertionError(message)
971
raise AssertionError("%r is %r." % (left, right))
973
def assertTransportMode(self, transport, path, mode):
974
"""Fail if a path does not have mode mode.
976
If modes are not supported on this transport, the assertion is ignored.
978
if not transport._can_roundtrip_unix_modebits():
980
path_stat = transport.stat(path)
981
actual_mode = stat.S_IMODE(path_stat.st_mode)
982
self.assertEqual(mode, actual_mode,
983
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
985
def assertIsSameRealPath(self, path1, path2):
986
"""Fail if path1 and path2 points to different files"""
987
self.assertEqual(osutils.realpath(path1),
988
osutils.realpath(path2),
989
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
991
def assertIsInstance(self, obj, kls):
992
"""Fail if obj is not an instance of kls"""
993
if not isinstance(obj, kls):
994
self.fail("%r is an instance of %s rather than %s" % (
995
obj, obj.__class__, kls))
997
def expectFailure(self, reason, assertion, *args, **kwargs):
998
"""Invoke a test, expecting it to fail for the given reason.
1000
This is for assertions that ought to succeed, but currently fail.
1001
(The failure is *expected* but not *wanted*.) Please be very precise
1002
about the failure you're expecting. If a new bug is introduced,
1003
AssertionError should be raised, not KnownFailure.
1005
Frequently, expectFailure should be followed by an opposite assertion.
1008
Intended to be used with a callable that raises AssertionError as the
1009
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1011
Raises KnownFailure if the test fails. Raises AssertionError if the
1016
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1018
self.assertEqual(42, dynamic_val)
1020
This means that a dynamic_val of 54 will cause the test to raise
1021
a KnownFailure. Once math is fixed and the expectFailure is removed,
1022
only a dynamic_val of 42 will allow the test to pass. Anything other
1023
than 54 or 42 will cause an AssertionError.
1026
assertion(*args, **kwargs)
1027
except AssertionError:
1028
raise KnownFailure(reason)
1030
self.fail('Unexpected success. Should have failed: %s' % reason)
1032
def _capture_warnings(self, a_callable, *args, **kwargs):
1033
"""A helper for callDeprecated and applyDeprecated.
1035
:param a_callable: A callable to call.
1036
:param args: The positional arguments for the callable
1037
:param kwargs: The keyword arguments for the callable
1038
:return: A tuple (warnings, result). result is the result of calling
1039
a_callable(``*args``, ``**kwargs``).
1042
def capture_warnings(msg, cls=None, stacklevel=None):
1043
# we've hooked into a deprecation specific callpath,
1044
# only deprecations should getting sent via it.
1045
self.assertEqual(cls, DeprecationWarning)
1046
local_warnings.append(msg)
1047
original_warning_method = symbol_versioning.warn
1048
symbol_versioning.set_warning_method(capture_warnings)
1050
result = a_callable(*args, **kwargs)
1052
symbol_versioning.set_warning_method(original_warning_method)
1053
return (local_warnings, result)
1055
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1056
"""Call a deprecated callable without warning the user.
1058
Note that this only captures warnings raised by symbol_versioning.warn,
1059
not other callers that go direct to the warning module.
1061
To test that a deprecated method raises an error, do something like
1064
self.assertRaises(errors.ReservedId,
1065
self.applyDeprecated, zero_ninetyone,
1066
br.append_revision, 'current:')
1068
:param deprecation_format: The deprecation format that the callable
1069
should have been deprecated with. This is the same type as the
1070
parameter to deprecated_method/deprecated_function. If the
1071
callable is not deprecated with this format, an assertion error
1073
:param a_callable: A callable to call. This may be a bound method or
1074
a regular function. It will be called with ``*args`` and
1076
:param args: The positional arguments for the callable
1077
:param kwargs: The keyword arguments for the callable
1078
:return: The result of a_callable(``*args``, ``**kwargs``)
1080
call_warnings, result = self._capture_warnings(a_callable,
1082
expected_first_warning = symbol_versioning.deprecation_string(
1083
a_callable, deprecation_format)
1084
if len(call_warnings) == 0:
1085
self.fail("No deprecation warning generated by call to %s" %
1087
self.assertEqual(expected_first_warning, call_warnings[0])
1090
def callDeprecated(self, expected, callable, *args, **kwargs):
1091
"""Assert that a callable is deprecated in a particular way.
1093
This is a very precise test for unusual requirements. The
1094
applyDeprecated helper function is probably more suited for most tests
1095
as it allows you to simply specify the deprecation format being used
1096
and will ensure that that is issued for the function being called.
1098
Note that this only captures warnings raised by symbol_versioning.warn,
1099
not other callers that go direct to the warning module.
1101
:param expected: a list of the deprecation warnings expected, in order
1102
:param callable: The callable to call
1103
:param args: The positional arguments for the callable
1104
:param kwargs: The keyword arguments for the callable
1106
call_warnings, result = self._capture_warnings(callable,
1108
self.assertEqual(expected, call_warnings)
1111
def _startLogFile(self):
1112
"""Send bzr and test log messages to a temporary file.
1114
The file is removed as the test is torn down.
1116
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1117
self._log_file = os.fdopen(fileno, 'w+')
1118
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1119
self._log_file_name = name
1120
self.addCleanup(self._finishLogFile)
1122
def _finishLogFile(self):
1123
"""Finished with the log file.
1125
Close the file and delete it, unless setKeepLogfile was called.
1127
if self._log_file is None:
1129
bzrlib.trace.disable_test_log(self._log_nonce)
1130
self._log_file.close()
1131
self._log_file = None
1132
if not self._keep_log_file:
1133
os.remove(self._log_file_name)
1134
self._log_file_name = None
1136
def setKeepLogfile(self):
1137
"""Make the logfile not be deleted when _finishLogFile is called."""
1138
self._keep_log_file = True
1140
def addCleanup(self, callable):
1141
"""Arrange to run a callable when this case is torn down.
1143
Callables are run in the reverse of the order they are registered,
1144
ie last-in first-out.
1146
if callable in self._cleanups:
1147
raise ValueError("cleanup function %r already registered on %s"
1149
self._cleanups.append(callable)
1151
def _cleanEnvironment(self):
1153
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1154
'HOME': os.getcwd(),
1155
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1156
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1158
'BZREMAIL': None, # may still be present in the environment
1160
'BZR_PROGRESS_BAR': None,
1162
'SSH_AUTH_SOCK': None,
1166
'https_proxy': None,
1167
'HTTPS_PROXY': None,
1172
# Nobody cares about these ones AFAIK. So far at
1173
# least. If you do (care), please update this comment
1177
'BZR_REMOTE_PATH': None,
1180
self.addCleanup(self._restoreEnvironment)
1181
for name, value in new_env.iteritems():
1182
self._captureVar(name, value)
1184
def _captureVar(self, name, newvalue):
1185
"""Set an environment variable, and reset it when finished."""
1186
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1188
def _restore_debug_flags(self):
1189
debug.debug_flags.clear()
1190
debug.debug_flags.update(self._preserved_debug_flags)
1192
def _restoreEnvironment(self):
1193
for name, value in self.__old_env.iteritems():
1194
osutils.set_or_unset_env(name, value)
1196
def _restoreHooks(self):
1197
for klass, hooks in self._preserved_hooks.items():
1198
setattr(klass, 'hooks', hooks)
1200
def knownFailure(self, reason):
1201
"""This test has failed for some known reason."""
1202
raise KnownFailure(reason)
1204
def run(self, result=None):
1205
if result is None: result = self.defaultTestResult()
1206
for feature in getattr(self, '_test_needs_features', []):
1207
if not feature.available():
1208
result.startTest(self)
1209
if getattr(result, 'addNotSupported', None):
1210
result.addNotSupported(self, feature)
1212
result.addSuccess(self)
1213
result.stopTest(self)
1215
return unittest.TestCase.run(self, result)
1219
unittest.TestCase.tearDown(self)
1221
def time(self, callable, *args, **kwargs):
1222
"""Run callable and accrue the time it takes to the benchmark time.
1224
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1225
this will cause lsprofile statistics to be gathered and stored in
1228
if self._benchtime is None:
1232
if not self._gather_lsprof_in_benchmarks:
1233
return callable(*args, **kwargs)
1235
# record this benchmark
1236
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1238
self._benchcalls.append(((callable, args, kwargs), stats))
1241
self._benchtime += time.time() - start
1243
def _runCleanups(self):
1244
"""Run registered cleanup functions.
1246
This should only be called from TestCase.tearDown.
1248
# TODO: Perhaps this should keep running cleanups even if
1249
# one of them fails?
1251
# Actually pop the cleanups from the list so tearDown running
1252
# twice is safe (this happens for skipped tests).
1253
while self._cleanups:
1254
self._cleanups.pop()()
1256
def log(self, *args):
1259
def _get_log(self, keep_log_file=False):
1260
"""Get the log from bzrlib.trace calls from this test.
1262
:param keep_log_file: When True, if the log is still a file on disk
1263
leave it as a file on disk. When False, if the log is still a file
1264
on disk, the log file is deleted and the log preserved as
1266
:return: A string containing the log.
1268
# flush the log file, to get all content
1270
bzrlib.trace._trace_file.flush()
1271
if self._log_contents:
1272
return self._log_contents
1273
if self._log_file_name is not None:
1274
logfile = open(self._log_file_name)
1276
log_contents = logfile.read()
1279
if not keep_log_file:
1280
self._log_contents = log_contents
1282
os.remove(self._log_file_name)
1284
if sys.platform == 'win32' and e.errno == errno.EACCES:
1285
print >>sys.stderr, ('Unable to delete log file '
1286
' %r' % self._log_file_name)
1291
return "DELETED log file to reduce memory footprint"
1293
def requireFeature(self, feature):
1294
"""This test requires a specific feature is available.
1296
:raises UnavailableFeature: When feature is not available.
1298
if not feature.available():
1299
raise UnavailableFeature(feature)
1301
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1303
"""Run bazaar command line, splitting up a string command line."""
1304
if isinstance(args, basestring):
1305
# shlex don't understand unicode strings,
1306
# so args should be plain string (bialix 20070906)
1307
args = list(shlex.split(str(args)))
1308
return self._run_bzr_core(args, retcode=retcode,
1309
encoding=encoding, stdin=stdin, working_dir=working_dir,
1312
def _run_bzr_core(self, args, retcode, encoding, stdin,
1314
if encoding is None:
1315
encoding = bzrlib.user_encoding
1316
stdout = StringIOWrapper()
1317
stderr = StringIOWrapper()
1318
stdout.encoding = encoding
1319
stderr.encoding = encoding
1321
self.log('run bzr: %r', args)
1322
# FIXME: don't call into logging here
1323
handler = logging.StreamHandler(stderr)
1324
handler.setLevel(logging.INFO)
1325
logger = logging.getLogger('')
1326
logger.addHandler(handler)
1327
old_ui_factory = ui.ui_factory
1328
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1331
if working_dir is not None:
1332
cwd = osutils.getcwd()
1333
os.chdir(working_dir)
1336
result = self.apply_redirected(ui.ui_factory.stdin,
1338
bzrlib.commands.run_bzr_catch_user_errors,
1341
logger.removeHandler(handler)
1342
ui.ui_factory = old_ui_factory
1346
out = stdout.getvalue()
1347
err = stderr.getvalue()
1349
self.log('output:\n%r', out)
1351
self.log('errors:\n%r', err)
1352
if retcode is not None:
1353
self.assertEquals(retcode, result,
1354
message='Unexpected return code')
1357
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1358
working_dir=None, error_regexes=[], output_encoding=None):
1359
"""Invoke bzr, as if it were run from the command line.
1361
The argument list should not include the bzr program name - the
1362
first argument is normally the bzr command. Arguments may be
1363
passed in three ways:
1365
1- A list of strings, eg ["commit", "a"]. This is recommended
1366
when the command contains whitespace or metacharacters, or
1367
is built up at run time.
1369
2- A single string, eg "add a". This is the most convenient
1370
for hardcoded commands.
1372
This runs bzr through the interface that catches and reports
1373
errors, and with logging set to something approximating the
1374
default, so that error reporting can be checked.
1376
This should be the main method for tests that want to exercise the
1377
overall behavior of the bzr application (rather than a unit test
1378
or a functional test of the library.)
1380
This sends the stdout/stderr results into the test's log,
1381
where it may be useful for debugging. See also run_captured.
1383
:keyword stdin: A string to be used as stdin for the command.
1384
:keyword retcode: The status code the command should return;
1386
:keyword working_dir: The directory to run the command in
1387
:keyword error_regexes: A list of expected error messages. If
1388
specified they must be seen in the error output of the command.
1390
out, err = self._run_bzr_autosplit(
1395
working_dir=working_dir,
1397
for regex in error_regexes:
1398
self.assertContainsRe(err, regex)
1401
def run_bzr_error(self, error_regexes, *args, **kwargs):
1402
"""Run bzr, and check that stderr contains the supplied regexes
1404
:param error_regexes: Sequence of regular expressions which
1405
must each be found in the error output. The relative ordering
1407
:param args: command-line arguments for bzr
1408
:param kwargs: Keyword arguments which are interpreted by run_bzr
1409
This function changes the default value of retcode to be 3,
1410
since in most cases this is run when you expect bzr to fail.
1412
:return: (out, err) The actual output of running the command (in case
1413
you want to do more inspection)
1417
# Make sure that commit is failing because there is nothing to do
1418
self.run_bzr_error(['no changes to commit'],
1419
['commit', '-m', 'my commit comment'])
1420
# Make sure --strict is handling an unknown file, rather than
1421
# giving us the 'nothing to do' error
1422
self.build_tree(['unknown'])
1423
self.run_bzr_error(['Commit refused because there are unknown files'],
1424
['commit', --strict', '-m', 'my commit comment'])
1426
kwargs.setdefault('retcode', 3)
1427
kwargs['error_regexes'] = error_regexes
1428
out, err = self.run_bzr(*args, **kwargs)
1431
def run_bzr_subprocess(self, *args, **kwargs):
1432
"""Run bzr in a subprocess for testing.
1434
This starts a new Python interpreter and runs bzr in there.
1435
This should only be used for tests that have a justifiable need for
1436
this isolation: e.g. they are testing startup time, or signal
1437
handling, or early startup code, etc. Subprocess code can't be
1438
profiled or debugged so easily.
1440
:keyword retcode: The status code that is expected. Defaults to 0. If
1441
None is supplied, the status code is not checked.
1442
:keyword env_changes: A dictionary which lists changes to environment
1443
variables. A value of None will unset the env variable.
1444
The values must be strings. The change will only occur in the
1445
child, so you don't need to fix the environment after running.
1446
:keyword universal_newlines: Convert CRLF => LF
1447
:keyword allow_plugins: By default the subprocess is run with
1448
--no-plugins to ensure test reproducibility. Also, it is possible
1449
for system-wide plugins to create unexpected output on stderr,
1450
which can cause unnecessary test failures.
1452
env_changes = kwargs.get('env_changes', {})
1453
working_dir = kwargs.get('working_dir', None)
1454
allow_plugins = kwargs.get('allow_plugins', False)
1456
if isinstance(args[0], list):
1458
elif isinstance(args[0], basestring):
1459
args = list(shlex.split(args[0]))
1461
symbol_versioning.warn(zero_ninetyone %
1462
"passing varargs to run_bzr_subprocess",
1463
DeprecationWarning, stacklevel=3)
1464
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1465
working_dir=working_dir,
1466
allow_plugins=allow_plugins)
1467
# We distinguish between retcode=None and retcode not passed.
1468
supplied_retcode = kwargs.get('retcode', 0)
1469
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1470
universal_newlines=kwargs.get('universal_newlines', False),
1473
def start_bzr_subprocess(self, process_args, env_changes=None,
1474
skip_if_plan_to_signal=False,
1476
allow_plugins=False):
1477
"""Start bzr in a subprocess for testing.
1479
This starts a new Python interpreter and runs bzr in there.
1480
This should only be used for tests that have a justifiable need for
1481
this isolation: e.g. they are testing startup time, or signal
1482
handling, or early startup code, etc. Subprocess code can't be
1483
profiled or debugged so easily.
1485
:param process_args: a list of arguments to pass to the bzr executable,
1486
for example ``['--version']``.
1487
:param env_changes: A dictionary which lists changes to environment
1488
variables. A value of None will unset the env variable.
1489
The values must be strings. The change will only occur in the
1490
child, so you don't need to fix the environment after running.
1491
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1493
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1495
:returns: Popen object for the started process.
1497
if skip_if_plan_to_signal:
1498
if not getattr(os, 'kill', None):
1499
raise TestSkipped("os.kill not available.")
1501
if env_changes is None:
1505
def cleanup_environment():
1506
for env_var, value in env_changes.iteritems():
1507
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1509
def restore_environment():
1510
for env_var, value in old_env.iteritems():
1511
osutils.set_or_unset_env(env_var, value)
1513
bzr_path = self.get_bzr_path()
1516
if working_dir is not None:
1517
cwd = osutils.getcwd()
1518
os.chdir(working_dir)
1521
# win32 subprocess doesn't support preexec_fn
1522
# so we will avoid using it on all platforms, just to
1523
# make sure the code path is used, and we don't break on win32
1524
cleanup_environment()
1525
command = [sys.executable, bzr_path]
1526
if not allow_plugins:
1527
command.append('--no-plugins')
1528
command.extend(process_args)
1529
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1531
restore_environment()
1537
def _popen(self, *args, **kwargs):
1538
"""Place a call to Popen.
1540
Allows tests to override this method to intercept the calls made to
1541
Popen for introspection.
1543
return Popen(*args, **kwargs)
1545
def get_bzr_path(self):
1546
"""Return the path of the 'bzr' executable for this test suite."""
1547
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1548
if not os.path.isfile(bzr_path):
1549
# We are probably installed. Assume sys.argv is the right file
1550
bzr_path = sys.argv[0]
1553
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1554
universal_newlines=False, process_args=None):
1555
"""Finish the execution of process.
1557
:param process: the Popen object returned from start_bzr_subprocess.
1558
:param retcode: The status code that is expected. Defaults to 0. If
1559
None is supplied, the status code is not checked.
1560
:param send_signal: an optional signal to send to the process.
1561
:param universal_newlines: Convert CRLF => LF
1562
:returns: (stdout, stderr)
1564
if send_signal is not None:
1565
os.kill(process.pid, send_signal)
1566
out, err = process.communicate()
1568
if universal_newlines:
1569
out = out.replace('\r\n', '\n')
1570
err = err.replace('\r\n', '\n')
1572
if retcode is not None and retcode != process.returncode:
1573
if process_args is None:
1574
process_args = "(unknown args)"
1575
mutter('Output of bzr %s:\n%s', process_args, out)
1576
mutter('Error for bzr %s:\n%s', process_args, err)
1577
self.fail('Command bzr %s failed with retcode %s != %s'
1578
% (process_args, retcode, process.returncode))
1581
def check_inventory_shape(self, inv, shape):
1582
"""Compare an inventory to a list of expected names.
1584
Fail if they are not precisely equal.
1587
shape = list(shape) # copy
1588
for path, ie in inv.entries():
1589
name = path.replace('\\', '/')
1590
if ie.kind == 'directory':
1597
self.fail("expected paths not found in inventory: %r" % shape)
1599
self.fail("unexpected paths found in inventory: %r" % extras)
1601
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1602
a_callable=None, *args, **kwargs):
1603
"""Call callable with redirected std io pipes.
1605
Returns the return code."""
1606
if not callable(a_callable):
1607
raise ValueError("a_callable must be callable.")
1609
stdin = StringIO("")
1611
if getattr(self, "_log_file", None) is not None:
1612
stdout = self._log_file
1616
if getattr(self, "_log_file", None is not None):
1617
stderr = self._log_file
1620
real_stdin = sys.stdin
1621
real_stdout = sys.stdout
1622
real_stderr = sys.stderr
1627
return a_callable(*args, **kwargs)
1629
sys.stdout = real_stdout
1630
sys.stderr = real_stderr
1631
sys.stdin = real_stdin
1633
def reduceLockdirTimeout(self):
1634
"""Reduce the default lock timeout for the duration of the test, so that
1635
if LockContention occurs during a test, it does so quickly.
1637
Tests that expect to provoke LockContention errors should call this.
1639
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1641
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1642
self.addCleanup(resetTimeout)
1643
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1645
def make_utf8_encoded_stringio(self, encoding_type=None):
1646
"""Return a StringIOWrapper instance, that will encode Unicode
1649
if encoding_type is None:
1650
encoding_type = 'strict'
1652
output_encoding = 'utf-8'
1653
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1654
sio.encoding = output_encoding
1658
class TestCaseWithMemoryTransport(TestCase):
1659
"""Common test class for tests that do not need disk resources.
1661
Tests that need disk resources should derive from TestCaseWithTransport.
1663
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1665
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1666
a directory which does not exist. This serves to help ensure test isolation
1667
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1668
must exist. However, TestCaseWithMemoryTransport does not offer local
1669
file defaults for the transport in tests, nor does it obey the command line
1670
override, so tests that accidentally write to the common directory should
1673
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1674
a .bzr directory that stops us ascending higher into the filesystem.
1680
def __init__(self, methodName='runTest'):
1681
# allow test parameterisation after test construction and before test
1682
# execution. Variables that the parameteriser sets need to be
1683
# ones that are not set by setUp, or setUp will trash them.
1684
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1685
self.vfs_transport_factory = default_transport
1686
self.transport_server = None
1687
self.transport_readonly_server = None
1688
self.__vfs_server = None
1690
def get_transport(self, relpath=None):
1691
"""Return a writeable transport.
1693
This transport is for the test scratch space relative to
1696
:param relpath: a path relative to the base url.
1698
t = get_transport(self.get_url(relpath))
1699
self.assertFalse(t.is_readonly())
1702
def get_readonly_transport(self, relpath=None):
1703
"""Return a readonly transport for the test scratch space
1705
This can be used to test that operations which should only need
1706
readonly access in fact do not try to write.
1708
:param relpath: a path relative to the base url.
1710
t = get_transport(self.get_readonly_url(relpath))
1711
self.assertTrue(t.is_readonly())
1714
def create_transport_readonly_server(self):
1715
"""Create a transport server from class defined at init.
1717
This is mostly a hook for daughter classes.
1719
return self.transport_readonly_server()
1721
def get_readonly_server(self):
1722
"""Get the server instance for the readonly transport
1724
This is useful for some tests with specific servers to do diagnostics.
1726
if self.__readonly_server is None:
1727
if self.transport_readonly_server is None:
1728
# readonly decorator requested
1729
# bring up the server
1730
self.__readonly_server = ReadonlyServer()
1731
self.__readonly_server.setUp(self.get_vfs_only_server())
1733
self.__readonly_server = self.create_transport_readonly_server()
1734
self.__readonly_server.setUp(self.get_vfs_only_server())
1735
self.addCleanup(self.__readonly_server.tearDown)
1736
return self.__readonly_server
1738
def get_readonly_url(self, relpath=None):
1739
"""Get a URL for the readonly transport.
1741
This will either be backed by '.' or a decorator to the transport
1742
used by self.get_url()
1743
relpath provides for clients to get a path relative to the base url.
1744
These should only be downwards relative, not upwards.
1746
base = self.get_readonly_server().get_url()
1747
return self._adjust_url(base, relpath)
1749
def get_vfs_only_server(self):
1750
"""Get the vfs only read/write server instance.
1752
This is useful for some tests with specific servers that need
1755
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1756
is no means to override it.
1758
if self.__vfs_server is None:
1759
self.__vfs_server = MemoryServer()
1760
self.__vfs_server.setUp()
1761
self.addCleanup(self.__vfs_server.tearDown)
1762
return self.__vfs_server
1764
def get_server(self):
1765
"""Get the read/write server instance.
1767
This is useful for some tests with specific servers that need
1770
This is built from the self.transport_server factory. If that is None,
1771
then the self.get_vfs_server is returned.
1773
if self.__server is None:
1774
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1775
return self.get_vfs_only_server()
1777
# bring up a decorated means of access to the vfs only server.
1778
self.__server = self.transport_server()
1780
self.__server.setUp(self.get_vfs_only_server())
1781
except TypeError, e:
1782
# This should never happen; the try:Except here is to assist
1783
# developers having to update code rather than seeing an
1784
# uninformative TypeError.
1785
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1786
self.addCleanup(self.__server.tearDown)
1787
return self.__server
1789
def _adjust_url(self, base, relpath):
1790
"""Get a URL (or maybe a path) for the readwrite transport.
1792
This will either be backed by '.' or to an equivalent non-file based
1794
relpath provides for clients to get a path relative to the base url.
1795
These should only be downwards relative, not upwards.
1797
if relpath is not None and relpath != '.':
1798
if not base.endswith('/'):
1800
# XXX: Really base should be a url; we did after all call
1801
# get_url()! But sometimes it's just a path (from
1802
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1803
# to a non-escaped local path.
1804
if base.startswith('./') or base.startswith('/'):
1807
base += urlutils.escape(relpath)
1810
def get_url(self, relpath=None):
1811
"""Get a URL (or maybe a path) for the readwrite transport.
1813
This will either be backed by '.' or to an equivalent non-file based
1815
relpath provides for clients to get a path relative to the base url.
1816
These should only be downwards relative, not upwards.
1818
base = self.get_server().get_url()
1819
return self._adjust_url(base, relpath)
1821
def get_vfs_only_url(self, relpath=None):
1822
"""Get a URL (or maybe a path for the plain old vfs transport.
1824
This will never be a smart protocol. It always has all the
1825
capabilities of the local filesystem, but it might actually be a
1826
MemoryTransport or some other similar virtual filesystem.
1828
This is the backing transport (if any) of the server returned by
1829
get_url and get_readonly_url.
1831
:param relpath: provides for clients to get a path relative to the base
1832
url. These should only be downwards relative, not upwards.
1835
base = self.get_vfs_only_server().get_url()
1836
return self._adjust_url(base, relpath)
1838
def _create_safety_net(self):
1839
"""Make a fake bzr directory.
1841
This prevents any tests propagating up onto the TEST_ROOT directory's
1844
root = TestCaseWithMemoryTransport.TEST_ROOT
1845
bzrdir.BzrDir.create_standalone_workingtree(root)
1847
def _check_safety_net(self):
1848
"""Check that the safety .bzr directory have not been touched.
1850
_make_test_root have created a .bzr directory to prevent tests from
1851
propagating. This method ensures than a test did not leaked.
1853
root = TestCaseWithMemoryTransport.TEST_ROOT
1854
wt = workingtree.WorkingTree.open(root)
1855
last_rev = wt.last_revision()
1856
if last_rev != 'null:':
1857
# The current test have modified the /bzr directory, we need to
1858
# recreate a new one or all the followng tests will fail.
1859
# If you need to inspect its content uncomment the following line
1860
# import pdb; pdb.set_trace()
1861
_rmtree_temp_dir(root + '/.bzr')
1862
self._create_safety_net()
1863
raise AssertionError('%s/.bzr should not be modified' % root)
1865
def _make_test_root(self):
1866
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1867
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1868
TestCaseWithMemoryTransport.TEST_ROOT = root
1870
self._create_safety_net()
1872
# The same directory is used by all tests, and we're not
1873
# specifically told when all tests are finished. This will do.
1874
atexit.register(_rmtree_temp_dir, root)
1876
self.addCleanup(self._check_safety_net)
1878
def makeAndChdirToTestDir(self):
1879
"""Create a temporary directories for this one test.
1881
This must set self.test_home_dir and self.test_dir and chdir to
1884
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1886
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1887
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1888
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1890
def make_branch(self, relpath, format=None):
1891
"""Create a branch on the transport at relpath."""
1892
repo = self.make_repository(relpath, format=format)
1893
return repo.bzrdir.create_branch()
1895
def make_bzrdir(self, relpath, format=None):
1897
# might be a relative or absolute path
1898
maybe_a_url = self.get_url(relpath)
1899
segments = maybe_a_url.rsplit('/', 1)
1900
t = get_transport(maybe_a_url)
1901
if len(segments) > 1 and segments[-1] not in ('', '.'):
1905
if isinstance(format, basestring):
1906
format = bzrdir.format_registry.make_bzrdir(format)
1907
return format.initialize_on_transport(t)
1908
except errors.UninitializableFormat:
1909
raise TestSkipped("Format %s is not initializable." % format)
1911
def make_repository(self, relpath, shared=False, format=None):
1912
"""Create a repository on our default transport at relpath.
1914
Note that relpath must be a relative path, not a full url.
1916
# FIXME: If you create a remoterepository this returns the underlying
1917
# real format, which is incorrect. Actually we should make sure that
1918
# RemoteBzrDir returns a RemoteRepository.
1919
# maybe mbp 20070410
1920
made_control = self.make_bzrdir(relpath, format=format)
1921
return made_control.create_repository(shared=shared)
1923
def make_branch_and_memory_tree(self, relpath, format=None):
1924
"""Create a branch on the default transport and a MemoryTree for it."""
1925
b = self.make_branch(relpath, format=format)
1926
return memorytree.MemoryTree.create_on_branch(b)
1928
def overrideEnvironmentForTesting(self):
1929
os.environ['HOME'] = self.test_home_dir
1930
os.environ['BZR_HOME'] = self.test_home_dir
1933
super(TestCaseWithMemoryTransport, self).setUp()
1934
self._make_test_root()
1935
_currentdir = os.getcwdu()
1936
def _leaveDirectory():
1937
os.chdir(_currentdir)
1938
self.addCleanup(_leaveDirectory)
1939
self.makeAndChdirToTestDir()
1940
self.overrideEnvironmentForTesting()
1941
self.__readonly_server = None
1942
self.__server = None
1943
self.reduceLockdirTimeout()
1946
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1947
"""Derived class that runs a test within a temporary directory.
1949
This is useful for tests that need to create a branch, etc.
1951
The directory is created in a slightly complex way: for each
1952
Python invocation, a new temporary top-level directory is created.
1953
All test cases create their own directory within that. If the
1954
tests complete successfully, the directory is removed.
1956
:ivar test_base_dir: The path of the top-level directory for this
1957
test, which contains a home directory and a work directory.
1959
:ivar test_home_dir: An initially empty directory under test_base_dir
1960
which is used as $HOME for this test.
1962
:ivar test_dir: A directory under test_base_dir used as the current
1963
directory when the test proper is run.
1966
OVERRIDE_PYTHON = 'python'
1968
def check_file_contents(self, filename, expect):
1969
self.log("check contents of file %s" % filename)
1970
contents = file(filename, 'r').read()
1971
if contents != expect:
1972
self.log("expected: %r" % expect)
1973
self.log("actually: %r" % contents)
1974
self.fail("contents of %s not as expected" % filename)
1976
def makeAndChdirToTestDir(self):
1977
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1979
For TestCaseInTempDir we create a temporary directory based on the test
1980
name and then create two subdirs - test and home under it.
1982
# create a directory within the top level test directory
1983
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
1984
# now create test and home directories within this dir
1985
self.test_base_dir = candidate_dir
1986
self.test_home_dir = self.test_base_dir + '/home'
1987
os.mkdir(self.test_home_dir)
1988
self.test_dir = self.test_base_dir + '/work'
1989
os.mkdir(self.test_dir)
1990
os.chdir(self.test_dir)
1991
# put name of test inside
1992
f = file(self.test_base_dir + '/name', 'w')
1997
self.addCleanup(self.deleteTestDir)
1999
def deleteTestDir(self):
2000
os.chdir(self.TEST_ROOT)
2001
_rmtree_temp_dir(self.test_base_dir)
2003
def build_tree(self, shape, line_endings='binary', transport=None):
2004
"""Build a test tree according to a pattern.
2006
shape is a sequence of file specifications. If the final
2007
character is '/', a directory is created.
2009
This assumes that all the elements in the tree being built are new.
2011
This doesn't add anything to a branch.
2013
:param line_endings: Either 'binary' or 'native'
2014
in binary mode, exact contents are written in native mode, the
2015
line endings match the default platform endings.
2016
:param transport: A transport to write to, for building trees on VFS's.
2017
If the transport is readonly or None, "." is opened automatically.
2020
# It's OK to just create them using forward slashes on windows.
2021
if transport is None or transport.is_readonly():
2022
transport = get_transport(".")
2024
self.assert_(isinstance(name, basestring))
2026
transport.mkdir(urlutils.escape(name[:-1]))
2028
if line_endings == 'binary':
2030
elif line_endings == 'native':
2033
raise errors.BzrError(
2034
'Invalid line ending request %r' % line_endings)
2035
content = "contents of %s%s" % (name.encode('utf-8'), end)
2036
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2038
def build_tree_contents(self, shape):
2039
build_tree_contents(shape)
2041
def assertFileEqual(self, content, path):
2042
"""Fail if path does not contain 'content'."""
2043
self.failUnlessExists(path)
2044
f = file(path, 'rb')
2049
self.assertEqualDiff(content, s)
2051
def failUnlessExists(self, path):
2052
"""Fail unless path or paths, which may be abs or relative, exist."""
2053
if not isinstance(path, basestring):
2055
self.failUnlessExists(p)
2057
self.failUnless(osutils.lexists(path),path+" does not exist")
2059
def failIfExists(self, path):
2060
"""Fail if path or paths, which may be abs or relative, exist."""
2061
if not isinstance(path, basestring):
2063
self.failIfExists(p)
2065
self.failIf(osutils.lexists(path),path+" exists")
2067
def assertInWorkingTree(self, path, root_path='.', tree=None):
2068
"""Assert whether path or paths are in the WorkingTree"""
2070
tree = workingtree.WorkingTree.open(root_path)
2071
if not isinstance(path, basestring):
2073
self.assertInWorkingTree(p,tree=tree)
2075
self.assertIsNot(tree.path2id(path), None,
2076
path+' not in working tree.')
2078
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2079
"""Assert whether path or paths are not in the WorkingTree"""
2081
tree = workingtree.WorkingTree.open(root_path)
2082
if not isinstance(path, basestring):
2084
self.assertNotInWorkingTree(p,tree=tree)
2086
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2089
class TestCaseWithTransport(TestCaseInTempDir):
2090
"""A test case that provides get_url and get_readonly_url facilities.
2092
These back onto two transport servers, one for readonly access and one for
2095
If no explicit class is provided for readonly access, a
2096
ReadonlyTransportDecorator is used instead which allows the use of non disk
2097
based read write transports.
2099
If an explicit class is provided for readonly access, that server and the
2100
readwrite one must both define get_url() as resolving to os.getcwd().
2103
def get_vfs_only_server(self):
2104
"""See TestCaseWithMemoryTransport.
2106
This is useful for some tests with specific servers that need
2109
if self.__vfs_server is None:
2110
self.__vfs_server = self.vfs_transport_factory()
2111
self.__vfs_server.setUp()
2112
self.addCleanup(self.__vfs_server.tearDown)
2113
return self.__vfs_server
2115
def make_branch_and_tree(self, relpath, format=None):
2116
"""Create a branch on the transport and a tree locally.
2118
If the transport is not a LocalTransport, the Tree can't be created on
2119
the transport. In that case if the vfs_transport_factory is
2120
LocalURLServer the working tree is created in the local
2121
directory backing the transport, and the returned tree's branch and
2122
repository will also be accessed locally. Otherwise a lightweight
2123
checkout is created and returned.
2125
:param format: The BzrDirFormat.
2126
:returns: the WorkingTree.
2128
# TODO: always use the local disk path for the working tree,
2129
# this obviously requires a format that supports branch references
2130
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2132
b = self.make_branch(relpath, format=format)
2134
return b.bzrdir.create_workingtree()
2135
except errors.NotLocalUrl:
2136
# We can only make working trees locally at the moment. If the
2137
# transport can't support them, then we keep the non-disk-backed
2138
# branch and create a local checkout.
2139
if self.vfs_transport_factory is LocalURLServer:
2140
# the branch is colocated on disk, we cannot create a checkout.
2141
# hopefully callers will expect this.
2142
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2143
return local_controldir.create_workingtree()
2145
return b.create_checkout(relpath, lightweight=True)
2147
def assertIsDirectory(self, relpath, transport):
2148
"""Assert that relpath within transport is a directory.
2150
This may not be possible on all transports; in that case it propagates
2151
a TransportNotPossible.
2154
mode = transport.stat(relpath).st_mode
2155
except errors.NoSuchFile:
2156
self.fail("path %s is not a directory; no such file"
2158
if not stat.S_ISDIR(mode):
2159
self.fail("path %s is not a directory; has mode %#o"
2162
def assertTreesEqual(self, left, right):
2163
"""Check that left and right have the same content and properties."""
2164
# we use a tree delta to check for equality of the content, and we
2165
# manually check for equality of other things such as the parents list.
2166
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2167
differences = left.changes_from(right)
2168
self.assertFalse(differences.has_changed(),
2169
"Trees %r and %r are different: %r" % (left, right, differences))
2172
super(TestCaseWithTransport, self).setUp()
2173
self.__vfs_server = None
2176
class ChrootedTestCase(TestCaseWithTransport):
2177
"""A support class that provides readonly urls outside the local namespace.
2179
This is done by checking if self.transport_server is a MemoryServer. if it
2180
is then we are chrooted already, if it is not then an HttpServer is used
2183
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2184
be used without needed to redo it when a different
2185
subclass is in use ?
2189
super(ChrootedTestCase, self).setUp()
2190
if not self.vfs_transport_factory == MemoryServer:
2191
self.transport_readonly_server = HttpServer
2194
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2195
random_order=False):
2196
"""Create a test suite by filtering another one.
2198
:param suite: the source suite
2199
:param pattern: pattern that names must match
2200
:param exclude_pattern: pattern that names must not match, if any
2201
:param random_order: if True, tests in the new suite will be put in
2203
:returns: the newly created suite
2205
return sort_suite_by_re(suite, pattern, exclude_pattern,
2206
random_order, False)
2209
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2210
random_order=False, append_rest=True):
2211
"""Create a test suite by sorting another one.
2213
:param suite: the source suite
2214
:param pattern: pattern that names must match in order to go
2215
first in the new suite
2216
:param exclude_pattern: pattern that names must not match, if any
2217
:param random_order: if True, tests in the new suite will be put in
2219
:param append_rest: if False, pattern is a strict filter and not
2220
just an ordering directive
2221
:returns: the newly created suite
2225
filter_re = re.compile(pattern)
2226
if exclude_pattern is not None:
2227
exclude_re = re.compile(exclude_pattern)
2228
for test in iter_suite_tests(suite):
2230
if exclude_pattern is None or not exclude_re.search(test_id):
2231
if filter_re.search(test_id):
2236
random.shuffle(first)
2237
random.shuffle(second)
2238
return TestUtil.TestSuite(first + second)
2241
def run_suite(suite, name='test', verbose=False, pattern=".*",
2242
stop_on_failure=False,
2243
transport=None, lsprof_timed=None, bench_history=None,
2244
matching_tests_first=None,
2247
exclude_pattern=None,
2250
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2255
runner = TextTestRunner(stream=sys.stdout,
2257
verbosity=verbosity,
2258
bench_history=bench_history,
2259
list_only=list_only,
2261
runner.stop_on_failure=stop_on_failure
2262
# Initialise the random number generator and display the seed used.
2263
# We convert the seed to a long to make it reuseable across invocations.
2264
random_order = False
2265
if random_seed is not None:
2267
if random_seed == "now":
2268
random_seed = long(time.time())
2270
# Convert the seed to a long if we can
2272
random_seed = long(random_seed)
2275
runner.stream.writeln("Randomizing test order using seed %s\n" %
2277
random.seed(random_seed)
2278
# Customise the list of tests if requested
2279
if pattern != '.*' or exclude_pattern is not None or random_order:
2280
if matching_tests_first:
2281
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2284
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2286
result = runner.run(suite)
2289
return result.wasStrictlySuccessful()
2291
return result.wasSuccessful()
2294
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2296
test_suite_factory=None,
2299
matching_tests_first=None,
2302
exclude_pattern=None,
2305
"""Run the whole test suite under the enhanced runner"""
2306
# XXX: Very ugly way to do this...
2307
# Disable warning about old formats because we don't want it to disturb
2308
# any blackbox tests.
2309
from bzrlib import repository
2310
repository._deprecation_warning_done = True
2312
global default_transport
2313
if transport is None:
2314
transport = default_transport
2315
old_transport = default_transport
2316
default_transport = transport
2318
if test_suite_factory is None:
2319
suite = test_suite()
2321
suite = test_suite_factory()
2322
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2323
stop_on_failure=stop_on_failure,
2324
transport=transport,
2325
lsprof_timed=lsprof_timed,
2326
bench_history=bench_history,
2327
matching_tests_first=matching_tests_first,
2328
list_only=list_only,
2329
random_seed=random_seed,
2330
exclude_pattern=exclude_pattern,
2333
default_transport = old_transport
2337
"""Build and return TestSuite for the whole of bzrlib.
2339
This function can be replaced if you need to change the default test
2340
suite on a global basis, but it is not encouraged.
2343
'bzrlib.util.tests.test_bencode',
2344
'bzrlib.tests.test__dirstate_helpers',
2345
'bzrlib.tests.test_ancestry',
2346
'bzrlib.tests.test_annotate',
2347
'bzrlib.tests.test_api',
2348
'bzrlib.tests.test_atomicfile',
2349
'bzrlib.tests.test_bad_files',
2350
'bzrlib.tests.test_branch',
2351
'bzrlib.tests.test_branchbuilder',
2352
'bzrlib.tests.test_bugtracker',
2353
'bzrlib.tests.test_bundle',
2354
'bzrlib.tests.test_bzrdir',
2355
'bzrlib.tests.test_cache_utf8',
2356
'bzrlib.tests.test_commands',
2357
'bzrlib.tests.test_commit',
2358
'bzrlib.tests.test_commit_merge',
2359
'bzrlib.tests.test_config',
2360
'bzrlib.tests.test_conflicts',
2361
'bzrlib.tests.test_counted_lock',
2362
'bzrlib.tests.test_decorators',
2363
'bzrlib.tests.test_delta',
2364
'bzrlib.tests.test_deprecated_graph',
2365
'bzrlib.tests.test_diff',
2366
'bzrlib.tests.test_dirstate',
2367
'bzrlib.tests.test_email_message',
2368
'bzrlib.tests.test_errors',
2369
'bzrlib.tests.test_escaped_store',
2370
'bzrlib.tests.test_extract',
2371
'bzrlib.tests.test_fetch',
2372
'bzrlib.tests.test_ftp_transport',
2373
'bzrlib.tests.test_generate_docs',
2374
'bzrlib.tests.test_generate_ids',
2375
'bzrlib.tests.test_globbing',
2376
'bzrlib.tests.test_gpg',
2377
'bzrlib.tests.test_graph',
2378
'bzrlib.tests.test_hashcache',
2379
'bzrlib.tests.test_help',
2380
'bzrlib.tests.test_hooks',
2381
'bzrlib.tests.test_http',
2382
'bzrlib.tests.test_http_response',
2383
'bzrlib.tests.test_https_ca_bundle',
2384
'bzrlib.tests.test_identitymap',
2385
'bzrlib.tests.test_ignores',
2386
'bzrlib.tests.test_index',
2387
'bzrlib.tests.test_info',
2388
'bzrlib.tests.test_inv',
2389
'bzrlib.tests.test_knit',
2390
'bzrlib.tests.test_lazy_import',
2391
'bzrlib.tests.test_lazy_regex',
2392
'bzrlib.tests.test_lockdir',
2393
'bzrlib.tests.test_lockable_files',
2394
'bzrlib.tests.test_log',
2395
'bzrlib.tests.test_lsprof',
2396
'bzrlib.tests.test_mail_client',
2397
'bzrlib.tests.test_memorytree',
2398
'bzrlib.tests.test_merge',
2399
'bzrlib.tests.test_merge3',
2400
'bzrlib.tests.test_merge_core',
2401
'bzrlib.tests.test_merge_directive',
2402
'bzrlib.tests.test_missing',
2403
'bzrlib.tests.test_msgeditor',
2404
'bzrlib.tests.test_multiparent',
2405
'bzrlib.tests.test_nonascii',
2406
'bzrlib.tests.test_options',
2407
'bzrlib.tests.test_osutils',
2408
'bzrlib.tests.test_osutils_encodings',
2409
'bzrlib.tests.test_pack',
2410
'bzrlib.tests.test_patch',
2411
'bzrlib.tests.test_patches',
2412
'bzrlib.tests.test_permissions',
2413
'bzrlib.tests.test_plugins',
2414
'bzrlib.tests.test_progress',
2415
'bzrlib.tests.test_reconfigure',
2416
'bzrlib.tests.test_reconcile',
2417
'bzrlib.tests.test_registry',
2418
'bzrlib.tests.test_remote',
2419
'bzrlib.tests.test_repository',
2420
'bzrlib.tests.test_revert',
2421
'bzrlib.tests.test_revision',
2422
'bzrlib.tests.test_revisionnamespaces',
2423
'bzrlib.tests.test_revisiontree',
2424
'bzrlib.tests.test_rio',
2425
'bzrlib.tests.test_sampler',
2426
'bzrlib.tests.test_selftest',
2427
'bzrlib.tests.test_setup',
2428
'bzrlib.tests.test_sftp_transport',
2429
'bzrlib.tests.test_smart',
2430
'bzrlib.tests.test_smart_add',
2431
'bzrlib.tests.test_smart_transport',
2432
'bzrlib.tests.test_smtp_connection',
2433
'bzrlib.tests.test_source',
2434
'bzrlib.tests.test_ssh_transport',
2435
'bzrlib.tests.test_status',
2436
'bzrlib.tests.test_store',
2437
'bzrlib.tests.test_strace',
2438
'bzrlib.tests.test_subsume',
2439
'bzrlib.tests.test_symbol_versioning',
2440
'bzrlib.tests.test_tag',
2441
'bzrlib.tests.test_testament',
2442
'bzrlib.tests.test_textfile',
2443
'bzrlib.tests.test_textmerge',
2444
'bzrlib.tests.test_timestamp',
2445
'bzrlib.tests.test_trace',
2446
'bzrlib.tests.test_transactions',
2447
'bzrlib.tests.test_transform',
2448
'bzrlib.tests.test_transport',
2449
'bzrlib.tests.test_tree',
2450
'bzrlib.tests.test_treebuilder',
2451
'bzrlib.tests.test_tsort',
2452
'bzrlib.tests.test_tuned_gzip',
2453
'bzrlib.tests.test_ui',
2454
'bzrlib.tests.test_upgrade',
2455
'bzrlib.tests.test_urlutils',
2456
'bzrlib.tests.test_versionedfile',
2457
'bzrlib.tests.test_version',
2458
'bzrlib.tests.test_version_info',
2459
'bzrlib.tests.test_weave',
2460
'bzrlib.tests.test_whitebox',
2461
'bzrlib.tests.test_win32utils',
2462
'bzrlib.tests.test_workingtree',
2463
'bzrlib.tests.test_workingtree_4',
2464
'bzrlib.tests.test_wsgi',
2465
'bzrlib.tests.test_xml',
2467
test_transport_implementations = [
2468
'bzrlib.tests.test_transport_implementations',
2469
'bzrlib.tests.test_read_bundle',
2471
suite = TestUtil.TestSuite()
2472
loader = TestUtil.TestLoader()
2473
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2474
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2475
adapter = TransportTestProviderAdapter()
2476
adapt_modules(test_transport_implementations, adapter, loader, suite)
2477
for package in packages_to_test():
2478
suite.addTest(package.test_suite())
2479
for m in MODULES_TO_TEST:
2480
suite.addTest(loader.loadTestsFromModule(m))
2481
for m in MODULES_TO_DOCTEST:
2483
suite.addTest(doctest.DocTestSuite(m))
2484
except ValueError, e:
2485
print '**failed to get doctest for: %s\n%s' %(m,e)
2487
default_encoding = sys.getdefaultencoding()
2488
for name, plugin in bzrlib.plugin.plugins().items():
2490
plugin_suite = plugin.test_suite()
2491
except ImportError, e:
2492
bzrlib.trace.warning(
2493
'Unable to test plugin "%s": %s', name, e)
2495
if plugin_suite is not None:
2496
suite.addTest(plugin_suite)
2497
if default_encoding != sys.getdefaultencoding():
2498
bzrlib.trace.warning(
2499
'Plugin "%s" tried to reset default encoding to: %s', name,
2500
sys.getdefaultencoding())
2502
sys.setdefaultencoding(default_encoding)
2506
def multiply_tests_from_modules(module_name_list, scenario_iter):
2507
"""Adapt all tests in some given modules to given scenarios.
2509
This is the recommended public interface for test parameterization.
2510
Typically the test_suite() method for a per-implementation test
2511
suite will call multiply_tests_from_modules and return the
2514
:param module_name_list: List of fully-qualified names of test
2516
:param scenario_iter: Iterable of pairs of (scenario_name,
2517
scenario_param_dict).
2519
This returns a new TestSuite containing the cross product of
2520
all the tests in all the modules, each repeated for each scenario.
2521
Each test is adapted by adding the scenario name at the end
2522
of its name, and updating the test object's __dict__ with the
2523
scenario_param_dict.
2525
>>> r = multiply_tests_from_modules(
2526
... ['bzrlib.tests.test_sampler'],
2527
... [('one', dict(param=1)),
2528
... ('two', dict(param=2))])
2529
>>> tests = list(iter_suite_tests(r))
2533
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2539
loader = TestLoader()
2541
adapter = TestScenarioApplier()
2542
adapter.scenarios = list(scenario_iter)
2543
adapt_modules(module_name_list, adapter, loader, suite)
2547
def multiply_scenarios(scenarios_left, scenarios_right):
2548
"""Multiply two sets of scenarios.
2550
:returns: the cartesian product of the two sets of scenarios, that is
2551
a scenario for every possible combination of a left scenario and a
2555
('%s,%s' % (left_name, right_name),
2556
dict(left_dict.items() + right_dict.items()))
2557
for left_name, left_dict in scenarios_left
2558
for right_name, right_dict in scenarios_right]
2562
def adapt_modules(mods_list, adapter, loader, suite):
2563
"""Adapt the modules in mods_list using adapter and add to suite."""
2564
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2565
suite.addTests(adapter.adapt(test))
2568
def _rmtree_temp_dir(dirname):
2569
# If LANG=C we probably have created some bogus paths
2570
# which rmtree(unicode) will fail to delete
2571
# so make sure we are using rmtree(str) to delete everything
2572
# except on win32, where rmtree(str) will fail
2573
# since it doesn't have the property of byte-stream paths
2574
# (they are either ascii or mbcs)
2575
if sys.platform == 'win32':
2576
# make sure we are using the unicode win32 api
2577
dirname = unicode(dirname)
2579
dirname = dirname.encode(sys.getfilesystemencoding())
2581
osutils.rmtree(dirname)
2583
if sys.platform == 'win32' and e.errno == errno.EACCES:
2584
print >>sys.stderr, ('Permission denied: '
2585
'unable to remove testing dir '
2586
'%s' % os.path.basename(dirname))
2591
class Feature(object):
2592
"""An operating system Feature."""
2595
self._available = None
2597
def available(self):
2598
"""Is the feature available?
2600
:return: True if the feature is available.
2602
if self._available is None:
2603
self._available = self._probe()
2604
return self._available
2607
"""Implement this method in concrete features.
2609
:return: True if the feature is available.
2611
raise NotImplementedError
2614
if getattr(self, 'feature_name', None):
2615
return self.feature_name()
2616
return self.__class__.__name__
2619
class _SymlinkFeature(Feature):
2622
return osutils.has_symlinks()
2624
def feature_name(self):
2627
SymlinkFeature = _SymlinkFeature()
2630
class TestScenarioApplier(object):
2631
"""A tool to apply scenarios to tests."""
2633
def adapt(self, test):
2634
"""Return a TestSuite containing a copy of test for each scenario."""
2635
result = unittest.TestSuite()
2636
for scenario in self.scenarios:
2637
result.addTest(self.adapt_test_to_scenario(test, scenario))
2640
def adapt_test_to_scenario(self, test, scenario):
2641
"""Copy test and apply scenario to it.
2643
:param test: A test to adapt.
2644
:param scenario: A tuple describing the scenarion.
2645
The first element of the tuple is the new test id.
2646
The second element is a dict containing attributes to set on the
2648
:return: The adapted test.
2650
from copy import deepcopy
2651
new_test = deepcopy(test)
2652
for name, value in scenario[1].items():
2653
setattr(new_test, name, value)
2654
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2655
new_test.id = lambda: new_id
2659
def probe_unicode_in_user_encoding():
2660
"""Try to encode several unicode strings to use in unicode-aware tests.
2661
Return first successfull match.
2663
:return: (unicode value, encoded plain string value) or (None, None)
2665
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2666
for uni_val in possible_vals:
2668
str_val = uni_val.encode(bzrlib.user_encoding)
2669
except UnicodeEncodeError:
2670
# Try a different character
2673
return uni_val, str_val
2677
def probe_bad_non_ascii(encoding):
2678
"""Try to find [bad] character with code [128..255]
2679
that cannot be decoded to unicode in some encoding.
2680
Return None if all non-ascii characters is valid
2683
for i in xrange(128, 256):
2686
char.decode(encoding)
2687
except UnicodeDecodeError:
added
removed
bzrlib/tests/__init__.py
