1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
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
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
86
from bzrlib.transport import get_transport
87
import bzrlib.transport
88
from bzrlib.transport.local import LocalURLServer
89
from bzrlib.transport.memory import MemoryServer
90
from bzrlib.transport.readonly import ReadonlyServer
91
from bzrlib.trace import mutter, note
92
from bzrlib.tests import TestUtil
93
from bzrlib.tests.HttpServer import HttpServer
94
from bzrlib.tests.TestUtil import (
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
20
108
MODULES_TO_TEST = []
21
MODULES_TO_DOCTEST = []
24
from unittest import TestLoader, TestSuite
25
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
26
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
27
global MODULES_TO_TEST, MODULES_TO_DOCTEST
29
import bzrlib.selftest.whitebox
30
import bzrlib.selftest.blackbox
31
import bzrlib.selftest.versioning
32
import bzrlib.selftest.testmerge3
33
import bzrlib.selftest.testhashcache
34
import bzrlib.selftest.testrevisionnamespaces
35
import bzrlib.selftest.testbranch
36
import bzrlib.selftest.teststatus
37
import bzrlib.selftest.testinv
38
import bzrlib.merge_core
39
from doctest import DocTestSuite
46
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
47
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
48
if m not in MODULES_TO_DOCTEST:
49
MODULES_TO_DOCTEST.append(m)
51
for m in (bzrlib.selftest.whitebox,
52
bzrlib.selftest.versioning,
53
bzrlib.selftest.testinv,
54
bzrlib.selftest.testmerge3,
55
bzrlib.selftest.testhashcache,
56
bzrlib.selftest.teststatus,
57
bzrlib.selftest.blackbox,
58
bzrlib.selftest.testhashcache,
59
bzrlib.selftest.testrevisionnamespaces,
60
bzrlib.selftest.testbranch,
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 this 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:
359
print >>self.stream, \
360
('vvvv[log from %s]' % test.id()).ljust(78,'-')
361
print >>self.stream, test._get_log()
362
print >>self.stream, \
363
('^^^^[log from %s]' % test.id()).ljust(78,'-')
364
self.stream.writeln(self.separator2)
365
self.stream.writeln("%s" % err)
370
def report_cleaning_up(self):
373
def report_success(self, test):
376
def wasStrictlySuccessful(self):
377
if self.unsupported or self.known_failure_count:
379
return self.wasSuccessful()
382
class TextTestResult(ExtendedTestResult):
383
"""Displays progress and results of tests in text form"""
385
def __init__(self, stream, descriptions, verbosity,
390
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
391
bench_history, num_tests)
393
self.pb = self.ui.nested_progress_bar()
394
self._supplied_pb = False
397
self._supplied_pb = True
398
self.pb.show_pct = False
399
self.pb.show_spinner = False
400
self.pb.show_eta = False,
401
self.pb.show_count = False
402
self.pb.show_bar = False
404
def report_starting(self):
405
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
407
def _progress_prefix_text(self):
408
a = '[%d' % self.count
409
if self.num_tests is not None:
410
a +='/%d' % self.num_tests
411
a += ' in %ds' % (time.time() - self._overall_start_time)
413
a += ', %d errors' % self.error_count
414
if self.failure_count:
415
a += ', %d failed' % self.failure_count
416
if self.known_failure_count:
417
a += ', %d known failures' % self.known_failure_count
419
a += ', %d skipped' % self.skip_count
421
a += ', %d missing features' % len(self.unsupported)
425
def report_test_start(self, test):
428
self._progress_prefix_text()
430
+ self._shortened_test_description(test))
432
def _test_description(self, test):
433
return self._shortened_test_description(test)
435
def report_error(self, test, err):
436
self.pb.note('ERROR: %s\n %s\n',
437
self._test_description(test),
441
def report_failure(self, test, err):
442
self.pb.note('FAIL: %s\n %s\n',
443
self._test_description(test),
447
def report_known_failure(self, test, err):
448
self.pb.note('XFAIL: %s\n%s\n',
449
self._test_description(test), err[1])
451
def report_skip(self, test, skip_excinfo):
454
def report_not_applicable(self, test, skip_excinfo):
457
def report_unsupported(self, test, feature):
458
"""test cannot be run because feature is missing."""
460
def report_cleaning_up(self):
461
self.pb.update('cleaning up...')
464
if not self._supplied_pb:
468
class VerboseTestResult(ExtendedTestResult):
469
"""Produce long output, with one line per test run plus times"""
471
def _ellipsize_to_right(self, a_string, final_width):
472
"""Truncate and pad a string, keeping the right hand side"""
473
if len(a_string) > final_width:
474
result = '...' + a_string[3-final_width:]
477
return result.ljust(final_width)
479
def report_starting(self):
480
self.stream.write('running %d tests...\n' % self.num_tests)
482
def report_test_start(self, test):
484
name = self._shortened_test_description(test)
485
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
486
# numbers, plus a trailing blank
487
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
488
self.stream.write(self._ellipsize_to_right(name,
489
osutils.terminal_width()-30))
492
def _error_summary(self, err):
494
return '%s%s' % (indent, err[1])
496
def report_error(self, test, err):
497
self.stream.writeln('ERROR %s\n%s'
498
% (self._testTimeString(test),
499
self._error_summary(err)))
501
def report_failure(self, test, err):
502
self.stream.writeln(' FAIL %s\n%s'
503
% (self._testTimeString(test),
504
self._error_summary(err)))
506
def report_known_failure(self, test, err):
507
self.stream.writeln('XFAIL %s\n%s'
508
% (self._testTimeString(test),
509
self._error_summary(err)))
511
def report_success(self, test):
512
self.stream.writeln(' OK %s' % self._testTimeString(test))
513
for bench_called, stats in getattr(test, '_benchcalls', []):
514
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
515
stats.pprint(file=self.stream)
516
# flush the stream so that we get smooth output. This verbose mode is
517
# used to show the output in PQM.
520
def report_skip(self, test, skip_excinfo):
521
self.stream.writeln(' SKIP %s\n%s'
522
% (self._testTimeString(test),
523
self._error_summary(skip_excinfo)))
525
def report_not_applicable(self, test, skip_excinfo):
526
self.stream.writeln(' N/A %s\n%s'
527
% (self._testTimeString(test),
528
self._error_summary(skip_excinfo)))
530
def report_unsupported(self, test, feature):
531
"""test cannot be run because feature is missing."""
532
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
533
%(self._testTimeString(test), feature))
536
class TextTestRunner(object):
537
stop_on_failure = False
546
self.stream = unittest._WritelnDecorator(stream)
547
self.descriptions = descriptions
548
self.verbosity = verbosity
549
self._bench_history = bench_history
550
self.list_only = list_only
553
"Run the given test case or test suite."
554
startTime = time.time()
555
if self.verbosity == 1:
556
result_class = TextTestResult
557
elif self.verbosity >= 2:
558
result_class = VerboseTestResult
559
result = result_class(self.stream,
562
bench_history=self._bench_history,
563
num_tests=test.countTestCases(),
565
result.stop_early = self.stop_on_failure
566
result.report_starting()
568
if self.verbosity >= 2:
569
self.stream.writeln("Listing tests only ...\n")
571
for t in iter_suite_tests(test):
572
self.stream.writeln("%s" % (t.id()))
574
actionTaken = "Listed"
577
run = result.testsRun
579
stopTime = time.time()
580
timeTaken = stopTime - startTime
582
self.stream.writeln(result.separator2)
583
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
584
run, run != 1 and "s" or "", timeTaken))
585
self.stream.writeln()
586
if not result.wasSuccessful():
587
self.stream.write("FAILED (")
588
failed, errored = map(len, (result.failures, result.errors))
590
self.stream.write("failures=%d" % failed)
592
if failed: self.stream.write(", ")
593
self.stream.write("errors=%d" % errored)
594
if result.known_failure_count:
595
if failed or errored: self.stream.write(", ")
596
self.stream.write("known_failure_count=%d" %
597
result.known_failure_count)
598
self.stream.writeln(")")
600
if result.known_failure_count:
601
self.stream.writeln("OK (known_failures=%d)" %
602
result.known_failure_count)
604
self.stream.writeln("OK")
605
if result.skip_count > 0:
606
skipped = result.skip_count
607
self.stream.writeln('%d test%s skipped' %
608
(skipped, skipped != 1 and "s" or ""))
609
if result.unsupported:
610
for feature, count in sorted(result.unsupported.items()):
611
self.stream.writeln("Missing feature '%s' skipped %d tests." %
617
def iter_suite_tests(suite):
618
"""Return all tests in a suite, recursing through nested suites"""
619
for item in suite._tests:
620
if isinstance(item, unittest.TestCase):
622
elif isinstance(item, unittest.TestSuite):
623
for r in iter_suite_tests(item):
626
raise Exception('unknown object %r inside test suite %r'
630
class TestSkipped(Exception):
631
"""Indicates that a test was intentionally skipped, rather than failing."""
634
class TestNotApplicable(TestSkipped):
635
"""A test is not applicable to the situation where it was run.
637
This is only normally raised by parameterized tests, if they find that
638
the instance they're constructed upon does not support one aspect
643
class KnownFailure(AssertionError):
644
"""Indicates that a test failed in a precisely expected manner.
646
Such failures dont block the whole test suite from passing because they are
647
indicators of partially completed code or of future work. We have an
648
explicit error for them so that we can ensure that they are always visible:
649
KnownFailures are always shown in the output of bzr selftest.
653
class UnavailableFeature(Exception):
654
"""A feature required for this test was not available.
656
The feature should be used to construct the exception.
660
class CommandFailed(Exception):
664
class StringIOWrapper(object):
665
"""A wrapper around cStringIO which just adds an encoding attribute.
667
Internally we can check sys.stdout to see what the output encoding
668
should be. However, cStringIO has no encoding attribute that we can
669
set. So we wrap it instead.
674
def __init__(self, s=None):
676
self.__dict__['_cstring'] = StringIO(s)
678
self.__dict__['_cstring'] = StringIO()
680
def __getattr__(self, name, getattr=getattr):
681
return getattr(self.__dict__['_cstring'], name)
683
def __setattr__(self, name, val):
684
if name == 'encoding':
685
self.__dict__['encoding'] = val
687
return setattr(self._cstring, name, val)
690
class TestUIFactory(ui.CLIUIFactory):
691
"""A UI Factory for testing.
693
Hide the progress bar but emit note()s.
695
Allows get_password to be tested without real tty attached.
702
super(TestUIFactory, self).__init__()
703
if stdin is not None:
704
# We use a StringIOWrapper to be able to test various
705
# encodings, but the user is still responsible to
706
# encode the string and to set the encoding attribute
707
# of StringIOWrapper.
708
self.stdin = StringIOWrapper(stdin)
710
self.stdout = sys.stdout
714
self.stderr = sys.stderr
719
"""See progress.ProgressBar.clear()."""
721
def clear_term(self):
722
"""See progress.ProgressBar.clear_term()."""
724
def clear_term(self):
725
"""See progress.ProgressBar.clear_term()."""
728
"""See progress.ProgressBar.finished()."""
730
def note(self, fmt_string, *args, **kwargs):
731
"""See progress.ProgressBar.note()."""
732
self.stdout.write((fmt_string + "\n") % args)
734
def progress_bar(self):
737
def nested_progress_bar(self):
740
def update(self, message, count=None, total=None):
741
"""See progress.ProgressBar.update()."""
743
def get_non_echoed_password(self, prompt):
744
"""Get password from stdin without trying to handle the echo mode"""
746
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
747
password = self.stdin.readline()
750
if password[-1] == '\n':
751
password = password[:-1]
755
class TestCase(unittest.TestCase):
756
"""Base class for bzr unit tests.
758
Tests that need access to disk resources should subclass
759
TestCaseInTempDir not TestCase.
761
Error and debug log messages are redirected from their usual
762
location into a temporary file, the contents of which can be
763
retrieved by _get_log(). We use a real OS file, not an in-memory object,
764
so that it can also capture file IO. When the test completes this file
765
is read into memory and removed from disk.
767
There are also convenience functions to invoke bzr's command-line
768
routine, and to build and check bzr trees.
770
In addition to the usual method of overriding tearDown(), this class also
771
allows subclasses to register functions into the _cleanups list, which is
772
run in order as the object is torn down. It's less likely this will be
773
accidentally overlooked.
776
_log_file_name = None
778
_keep_log_file = False
779
# record lsprof data when performing benchmark calls.
780
_gather_lsprof_in_benchmarks = False
782
def __init__(self, methodName='testMethod'):
783
super(TestCase, self).__init__(methodName)
787
unittest.TestCase.setUp(self)
788
self._cleanEnvironment()
789
bzrlib.trace.disable_default_logging()
792
self._benchcalls = []
793
self._benchtime = None
795
self._clear_debug_flags()
797
def _clear_debug_flags(self):
798
"""Prevent externally set debug flags affecting tests.
800
Tests that want to use debug flags can just set them in the
801
debug_flags set during setup/teardown.
803
self._preserved_debug_flags = set(debug.debug_flags)
804
debug.debug_flags.clear()
805
self.addCleanup(self._restore_debug_flags)
807
def _clear_hooks(self):
808
# prevent hooks affecting tests
810
import bzrlib.smart.server
811
self._preserved_hooks = {
812
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
813
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
815
self.addCleanup(self._restoreHooks)
816
# reset all hooks to an empty instance of the appropriate type
817
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
818
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
820
def _silenceUI(self):
821
"""Turn off UI for duration of test"""
822
# by default the UI is off; tests can turn it on if they want it.
823
saved = ui.ui_factory
825
ui.ui_factory = saved
826
ui.ui_factory = ui.SilentUIFactory()
827
self.addCleanup(_restore)
829
def _ndiff_strings(self, a, b):
830
"""Return ndiff between two strings containing lines.
832
A trailing newline is added if missing to make the strings
834
if b and b[-1] != '\n':
836
if a and a[-1] != '\n':
838
difflines = difflib.ndiff(a.splitlines(True),
840
linejunk=lambda x: False,
841
charjunk=lambda x: False)
842
return ''.join(difflines)
844
def assertEqual(self, a, b, message=''):
848
except UnicodeError, e:
849
# If we can't compare without getting a UnicodeError, then
850
# obviously they are different
851
mutter('UnicodeError: %s', e)
854
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
856
pformat(a), pformat(b)))
858
assertEquals = assertEqual
860
def assertEqualDiff(self, a, b, message=None):
861
"""Assert two texts are equal, if not raise an exception.
863
This is intended for use with multi-line strings where it can
864
be hard to find the differences by eye.
866
# TODO: perhaps override assertEquals to call this for strings?
870
message = "texts not equal:\n"
871
raise AssertionError(message +
872
self._ndiff_strings(a, b))
874
def assertEqualMode(self, mode, mode_test):
875
self.assertEqual(mode, mode_test,
876
'mode mismatch %o != %o' % (mode, mode_test))
878
def assertPositive(self, val):
879
"""Assert that val is greater than 0."""
880
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
882
def assertNegative(self, val):
883
"""Assert that val is less than 0."""
884
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
886
def assertStartsWith(self, s, prefix):
887
if not s.startswith(prefix):
888
raise AssertionError('string %r does not start with %r' % (s, prefix))
890
def assertEndsWith(self, s, suffix):
891
"""Asserts that s ends with suffix."""
892
if not s.endswith(suffix):
893
raise AssertionError('string %r does not end with %r' % (s, suffix))
895
def assertContainsRe(self, haystack, needle_re):
896
"""Assert that a contains something matching a regular expression."""
897
if not re.search(needle_re, haystack):
898
if '\n' in haystack or len(haystack) > 60:
899
# a long string, format it in a more readable way
900
raise AssertionError(
901
'pattern "%s" not found in\n"""\\\n%s"""\n'
902
% (needle_re, haystack))
904
raise AssertionError('pattern "%s" not found in "%s"'
905
% (needle_re, haystack))
907
def assertNotContainsRe(self, haystack, needle_re):
908
"""Assert that a does not match a regular expression"""
909
if re.search(needle_re, haystack):
910
raise AssertionError('pattern "%s" found in "%s"'
911
% (needle_re, haystack))
913
def assertSubset(self, sublist, superlist):
914
"""Assert that every entry in sublist is present in superlist."""
915
missing = set(sublist) - set(superlist)
917
raise AssertionError("value(s) %r not present in container %r" %
918
(missing, superlist))
920
def assertListRaises(self, excClass, func, *args, **kwargs):
921
"""Fail unless excClass is raised when the iterator from func is used.
923
Many functions can return generators this makes sure
924
to wrap them in a list() call to make sure the whole generator
925
is run, and that the proper exception is raised.
928
list(func(*args, **kwargs))
932
if getattr(excClass,'__name__', None) is not None:
933
excName = excClass.__name__
935
excName = str(excClass)
936
raise self.failureException, "%s not raised" % excName
938
def assertRaises(self, excClass, callableObj, *args, **kwargs):
939
"""Assert that a callable raises a particular exception.
941
:param excClass: As for the except statement, this may be either an
942
exception class, or a tuple of classes.
943
:param callableObj: A callable, will be passed ``*args`` and
946
Returns the exception so that you can examine it.
949
callableObj(*args, **kwargs)
953
if getattr(excClass,'__name__', None) is not None:
954
excName = excClass.__name__
957
excName = str(excClass)
958
raise self.failureException, "%s not raised" % excName
960
def assertIs(self, left, right, message=None):
961
if not (left is right):
962
if message is not None:
963
raise AssertionError(message)
965
raise AssertionError("%r is not %r." % (left, right))
967
def assertIsNot(self, left, right, message=None):
969
if message is not None:
970
raise AssertionError(message)
972
raise AssertionError("%r is %r." % (left, right))
974
def assertTransportMode(self, transport, path, mode):
975
"""Fail if a path does not have mode mode.
977
If modes are not supported on this transport, the assertion is ignored.
979
if not transport._can_roundtrip_unix_modebits():
981
path_stat = transport.stat(path)
982
actual_mode = stat.S_IMODE(path_stat.st_mode)
983
self.assertEqual(mode, actual_mode,
984
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
986
def assertIsInstance(self, obj, kls):
987
"""Fail if obj is not an instance of kls"""
988
if not isinstance(obj, kls):
989
self.fail("%r is an instance of %s rather than %s" % (
990
obj, obj.__class__, kls))
992
def expectFailure(self, reason, assertion, *args, **kwargs):
993
"""Invoke a test, expecting it to fail for the given reason.
995
This is for assertions that ought to succeed, but currently fail.
996
(The failure is *expected* but not *wanted*.) Please be very precise
997
about the failure you're expecting. If a new bug is introduced,
998
AssertionError should be raised, not KnownFailure.
1000
Frequently, expectFailure should be followed by an opposite assertion.
1003
Intended to be used with a callable that raises AssertionError as the
1004
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1006
Raises KnownFailure if the test fails. Raises AssertionError if the
1011
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1013
self.assertEqual(42, dynamic_val)
1015
This means that a dynamic_val of 54 will cause the test to raise
1016
a KnownFailure. Once math is fixed and the expectFailure is removed,
1017
only a dynamic_val of 42 will allow the test to pass. Anything other
1018
than 54 or 42 will cause an AssertionError.
1021
assertion(*args, **kwargs)
1022
except AssertionError:
1023
raise KnownFailure(reason)
1025
self.fail('Unexpected success. Should have failed: %s' % reason)
1027
def _capture_warnings(self, a_callable, *args, **kwargs):
1028
"""A helper for callDeprecated and applyDeprecated.
1030
:param a_callable: A callable to call.
1031
:param args: The positional arguments for the callable
1032
:param kwargs: The keyword arguments for the callable
1033
:return: A tuple (warnings, result). result is the result of calling
1034
a_callable(``*args``, ``**kwargs``).
1037
def capture_warnings(msg, cls=None, stacklevel=None):
1038
# we've hooked into a deprecation specific callpath,
1039
# only deprecations should getting sent via it.
1040
self.assertEqual(cls, DeprecationWarning)
1041
local_warnings.append(msg)
1042
original_warning_method = symbol_versioning.warn
1043
symbol_versioning.set_warning_method(capture_warnings)
1045
result = a_callable(*args, **kwargs)
1047
symbol_versioning.set_warning_method(original_warning_method)
1048
return (local_warnings, result)
1050
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1051
"""Call a deprecated callable without warning the user.
1053
Note that this only captures warnings raised by symbol_versioning.warn,
1054
not other callers that go direct to the warning module.
1056
To test that a deprecated method raises an error, do something like
1059
self.assertRaises(errors.ReservedId,
1060
self.applyDeprecated, zero_ninetyone,
1061
br.append_revision, 'current:')
1063
:param deprecation_format: The deprecation format that the callable
1064
should have been deprecated with. This is the same type as the
1065
parameter to deprecated_method/deprecated_function. If the
1066
callable is not deprecated with this format, an assertion error
1068
:param a_callable: A callable to call. This may be a bound method or
1069
a regular function. It will be called with ``*args`` and
1071
:param args: The positional arguments for the callable
1072
:param kwargs: The keyword arguments for the callable
1073
:return: The result of a_callable(``*args``, ``**kwargs``)
1075
call_warnings, result = self._capture_warnings(a_callable,
1077
expected_first_warning = symbol_versioning.deprecation_string(
1078
a_callable, deprecation_format)
1079
if len(call_warnings) == 0:
1080
self.fail("No deprecation warning generated by call to %s" %
1082
self.assertEqual(expected_first_warning, call_warnings[0])
1085
def callDeprecated(self, expected, callable, *args, **kwargs):
1086
"""Assert that a callable is deprecated in a particular way.
1088
This is a very precise test for unusual requirements. The
1089
applyDeprecated helper function is probably more suited for most tests
1090
as it allows you to simply specify the deprecation format being used
1091
and will ensure that that is issued for the function being called.
1093
Note that this only captures warnings raised by symbol_versioning.warn,
1094
not other callers that go direct to the warning module.
1096
:param expected: a list of the deprecation warnings expected, in order
1097
:param callable: The callable to call
1098
:param args: The positional arguments for the callable
1099
:param kwargs: The keyword arguments for the callable
1101
call_warnings, result = self._capture_warnings(callable,
1103
self.assertEqual(expected, call_warnings)
1106
def _startLogFile(self):
1107
"""Send bzr and test log messages to a temporary file.
1109
The file is removed as the test is torn down.
1111
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1112
self._log_file = os.fdopen(fileno, 'w+')
1113
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1114
self._log_file_name = name
1115
self.addCleanup(self._finishLogFile)
1117
def _finishLogFile(self):
1118
"""Finished with the log file.
1120
Close the file and delete it, unless setKeepLogfile was called.
1122
if self._log_file is None:
1124
bzrlib.trace.disable_test_log(self._log_nonce)
1125
self._log_file.close()
1126
self._log_file = None
1127
if not self._keep_log_file:
1128
os.remove(self._log_file_name)
1129
self._log_file_name = None
1131
def setKeepLogfile(self):
1132
"""Make the logfile not be deleted when _finishLogFile is called."""
1133
self._keep_log_file = True
1135
def addCleanup(self, callable):
1136
"""Arrange to run a callable when this case is torn down.
1138
Callables are run in the reverse of the order they are registered,
1139
ie last-in first-out.
1141
if callable in self._cleanups:
1142
raise ValueError("cleanup function %r already registered on %s"
1144
self._cleanups.append(callable)
1146
def _cleanEnvironment(self):
1148
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1149
'HOME': os.getcwd(),
1150
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1152
'BZREMAIL': None, # may still be present in the environment
1154
'BZR_PROGRESS_BAR': None,
1156
'SSH_AUTH_SOCK': None,
1160
'https_proxy': None,
1161
'HTTPS_PROXY': None,
1166
# Nobody cares about these ones AFAIK. So far at
1167
# least. If you do (care), please update this comment
1171
'BZR_REMOTE_PATH': None,
1174
self.addCleanup(self._restoreEnvironment)
1175
for name, value in new_env.iteritems():
1176
self._captureVar(name, value)
1178
def _captureVar(self, name, newvalue):
1179
"""Set an environment variable, and reset it when finished."""
1180
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1182
def _restore_debug_flags(self):
1183
debug.debug_flags.clear()
1184
debug.debug_flags.update(self._preserved_debug_flags)
1186
def _restoreEnvironment(self):
1187
for name, value in self.__old_env.iteritems():
1188
osutils.set_or_unset_env(name, value)
1190
def _restoreHooks(self):
1191
for klass, hooks in self._preserved_hooks.items():
1192
setattr(klass, 'hooks', hooks)
1194
def knownFailure(self, reason):
1195
"""This test has failed for some known reason."""
1196
raise KnownFailure(reason)
1198
def run(self, result=None):
1199
if result is None: result = self.defaultTestResult()
1200
for feature in getattr(self, '_test_needs_features', []):
1201
if not feature.available():
1202
result.startTest(self)
1203
if getattr(result, 'addNotSupported', None):
1204
result.addNotSupported(self, feature)
1206
result.addSuccess(self)
1207
result.stopTest(self)
1209
return unittest.TestCase.run(self, result)
1213
unittest.TestCase.tearDown(self)
1215
def time(self, callable, *args, **kwargs):
1216
"""Run callable and accrue the time it takes to the benchmark time.
1218
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1219
this will cause lsprofile statistics to be gathered and stored in
1222
if self._benchtime is None:
1226
if not self._gather_lsprof_in_benchmarks:
1227
return callable(*args, **kwargs)
1229
# record this benchmark
1230
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1232
self._benchcalls.append(((callable, args, kwargs), stats))
1235
self._benchtime += time.time() - start
1237
def _runCleanups(self):
1238
"""Run registered cleanup functions.
1240
This should only be called from TestCase.tearDown.
1242
# TODO: Perhaps this should keep running cleanups even if
1243
# one of them fails?
1245
# Actually pop the cleanups from the list so tearDown running
1246
# twice is safe (this happens for skipped tests).
1247
while self._cleanups:
1248
self._cleanups.pop()()
1250
def log(self, *args):
1253
def _get_log(self, keep_log_file=False):
1254
"""Get the log from bzrlib.trace calls from this test.
1256
:param keep_log_file: When True, if the log is still a file on disk
1257
leave it as a file on disk. When False, if the log is still a file
1258
on disk, the log file is deleted and the log preserved as
1260
:return: A string containing the log.
1262
# flush the log file, to get all content
1264
bzrlib.trace._trace_file.flush()
1265
if self._log_contents:
1266
return self._log_contents
1267
if self._log_file_name is not None:
1268
logfile = open(self._log_file_name)
1270
log_contents = logfile.read()
1273
if not keep_log_file:
1274
self._log_contents = log_contents
1276
os.remove(self._log_file_name)
1278
if sys.platform == 'win32' and e.errno == errno.EACCES:
1279
print >>sys.stderr, ('Unable to delete log file '
1280
' %r' % self._log_file_name)
1285
return "DELETED log file to reduce memory footprint"
1287
@deprecated_method(zero_eighteen)
1288
def capture(self, cmd, retcode=0):
1289
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1290
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1292
def requireFeature(self, feature):
1293
"""This test requires a specific feature is available.
1295
:raises UnavailableFeature: When feature is not available.
1297
if not feature.available():
1298
raise UnavailableFeature(feature)
1300
@deprecated_method(zero_eighteen)
1301
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1303
"""Invoke bzr and return (stdout, stderr).
1305
Don't call this method, just use run_bzr() which is equivalent.
1307
:param argv: Arguments to invoke bzr. This may be either a
1308
single string, in which case it is split by shlex into words,
1309
or a list of arguments.
1310
:param retcode: Expected return code, or None for don't-care.
1311
:param encoding: Encoding for sys.stdout and sys.stderr
1312
:param stdin: A string to be used as stdin for the command.
1313
:param working_dir: Change to this directory before running
1315
return self._run_bzr_autosplit(argv, retcode=retcode,
1316
encoding=encoding, stdin=stdin, working_dir=working_dir,
1319
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1321
"""Run bazaar command line, splitting up a string command line."""
1322
if isinstance(args, basestring):
1323
args = list(shlex.split(args))
1324
return self._run_bzr_core(args, retcode=retcode,
1325
encoding=encoding, stdin=stdin, working_dir=working_dir,
1328
def _run_bzr_core(self, args, retcode, encoding, stdin,
1330
if encoding is None:
1331
encoding = bzrlib.user_encoding
1332
stdout = StringIOWrapper()
1333
stderr = StringIOWrapper()
1334
stdout.encoding = encoding
1335
stderr.encoding = encoding
1337
self.log('run bzr: %r', args)
1338
# FIXME: don't call into logging here
1339
handler = logging.StreamHandler(stderr)
1340
handler.setLevel(logging.INFO)
1341
logger = logging.getLogger('')
1342
logger.addHandler(handler)
1343
old_ui_factory = ui.ui_factory
1344
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1347
if working_dir is not None:
1348
cwd = osutils.getcwd()
1349
os.chdir(working_dir)
1352
result = self.apply_redirected(ui.ui_factory.stdin,
1354
bzrlib.commands.run_bzr_catch_errors,
1357
logger.removeHandler(handler)
1358
ui.ui_factory = old_ui_factory
1362
out = stdout.getvalue()
1363
err = stderr.getvalue()
1365
self.log('output:\n%r', out)
1367
self.log('errors:\n%r', err)
1368
if retcode is not None:
1369
self.assertEquals(retcode, result,
1370
message='Unexpected return code')
1373
def run_bzr(self, *args, **kwargs):
1374
"""Invoke bzr, as if it were run from the command line.
1376
The argument list should not include the bzr program name - the
1377
first argument is normally the bzr command. Arguments may be
1378
passed in three ways:
1380
1- A list of strings, eg ["commit", "a"]. This is recommended
1381
when the command contains whitespace or metacharacters, or
1382
is built up at run time.
1384
2- A single string, eg "add a". This is the most convenient
1385
for hardcoded commands.
1387
3- Several varargs parameters, eg run_bzr("add", "a").
1388
This is not recommended for new code.
1390
This runs bzr through the interface that catches and reports
1391
errors, and with logging set to something approximating the
1392
default, so that error reporting can be checked.
1394
This should be the main method for tests that want to exercise the
1395
overall behavior of the bzr application (rather than a unit test
1396
or a functional test of the library.)
1398
This sends the stdout/stderr results into the test's log,
1399
where it may be useful for debugging. See also run_captured.
1401
:keyword stdin: A string to be used as stdin for the command.
1402
:keyword retcode: The status code the command should return;
1404
:keyword working_dir: The directory to run the command in
1405
:keyword error_regexes: A list of expected error messages. If
1406
specified they must be seen in the error output of the command.
1408
retcode = kwargs.pop('retcode', 0)
1409
encoding = kwargs.pop('encoding', None)
1410
stdin = kwargs.pop('stdin', None)
1411
working_dir = kwargs.pop('working_dir', None)
1412
error_regexes = kwargs.pop('error_regexes', [])
1415
raise TypeError("run_bzr() got unexpected keyword arguments '%s'"
1419
if isinstance(args[0], (list, basestring)):
1422
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1423
DeprecationWarning, stacklevel=3)
1425
out, err = self._run_bzr_autosplit(args=args,
1427
encoding=encoding, stdin=stdin, working_dir=working_dir,
1430
for regex in error_regexes:
1431
self.assertContainsRe(err, regex)
1434
def run_bzr_decode(self, *args, **kwargs):
1435
if 'encoding' in kwargs:
1436
encoding = kwargs['encoding']
1438
encoding = bzrlib.user_encoding
1439
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1441
def run_bzr_error(self, error_regexes, *args, **kwargs):
1442
"""Run bzr, and check that stderr contains the supplied regexes
1444
:param error_regexes: Sequence of regular expressions which
1445
must each be found in the error output. The relative ordering
1447
:param args: command-line arguments for bzr
1448
:param kwargs: Keyword arguments which are interpreted by run_bzr
1449
This function changes the default value of retcode to be 3,
1450
since in most cases this is run when you expect bzr to fail.
1452
:return: (out, err) The actual output of running the command (in case
1453
you want to do more inspection)
1457
# Make sure that commit is failing because there is nothing to do
1458
self.run_bzr_error(['no changes to commit'],
1459
['commit', '-m', 'my commit comment'])
1460
# Make sure --strict is handling an unknown file, rather than
1461
# giving us the 'nothing to do' error
1462
self.build_tree(['unknown'])
1463
self.run_bzr_error(['Commit refused because there are unknown files'],
1464
['commit', --strict', '-m', 'my commit comment'])
1466
kwargs.setdefault('retcode', 3)
1467
kwargs['error_regexes'] = error_regexes
1468
out, err = self.run_bzr(*args, **kwargs)
1471
def run_bzr_subprocess(self, *args, **kwargs):
1472
"""Run bzr in a subprocess for testing.
1474
This starts a new Python interpreter and runs bzr in there.
1475
This should only be used for tests that have a justifiable need for
1476
this isolation: e.g. they are testing startup time, or signal
1477
handling, or early startup code, etc. Subprocess code can't be
1478
profiled or debugged so easily.
1480
:keyword retcode: The status code that is expected. Defaults to 0. If
1481
None is supplied, the status code is not checked.
1482
:keyword env_changes: A dictionary which lists changes to environment
1483
variables. A value of None will unset the env variable.
1484
The values must be strings. The change will only occur in the
1485
child, so you don't need to fix the environment after running.
1486
:keyword universal_newlines: Convert CRLF => LF
1487
:keyword allow_plugins: By default the subprocess is run with
1488
--no-plugins to ensure test reproducibility. Also, it is possible
1489
for system-wide plugins to create unexpected output on stderr,
1490
which can cause unnecessary test failures.
1492
env_changes = kwargs.get('env_changes', {})
1493
working_dir = kwargs.get('working_dir', None)
1494
allow_plugins = kwargs.get('allow_plugins', False)
1496
if isinstance(args[0], list):
1498
elif isinstance(args[0], basestring):
1499
args = list(shlex.split(args[0]))
1501
symbol_versioning.warn(zero_ninetyone %
1502
"passing varargs to run_bzr_subprocess",
1503
DeprecationWarning, stacklevel=3)
1504
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1505
working_dir=working_dir,
1506
allow_plugins=allow_plugins)
1507
# We distinguish between retcode=None and retcode not passed.
1508
supplied_retcode = kwargs.get('retcode', 0)
1509
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1510
universal_newlines=kwargs.get('universal_newlines', False),
1513
def start_bzr_subprocess(self, process_args, env_changes=None,
1514
skip_if_plan_to_signal=False,
1516
allow_plugins=False):
1517
"""Start bzr in a subprocess for testing.
1519
This starts a new Python interpreter and runs bzr in there.
1520
This should only be used for tests that have a justifiable need for
1521
this isolation: e.g. they are testing startup time, or signal
1522
handling, or early startup code, etc. Subprocess code can't be
1523
profiled or debugged so easily.
1525
:param process_args: a list of arguments to pass to the bzr executable,
1526
for example ``['--version']``.
1527
:param env_changes: A dictionary which lists changes to environment
1528
variables. A value of None will unset the env variable.
1529
The values must be strings. The change will only occur in the
1530
child, so you don't need to fix the environment after running.
1531
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1533
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1535
:returns: Popen object for the started process.
1537
if skip_if_plan_to_signal:
1538
if not getattr(os, 'kill', None):
1539
raise TestSkipped("os.kill not available.")
1541
if env_changes is None:
1545
def cleanup_environment():
1546
for env_var, value in env_changes.iteritems():
1547
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1549
def restore_environment():
1550
for env_var, value in old_env.iteritems():
1551
osutils.set_or_unset_env(env_var, value)
1553
bzr_path = self.get_bzr_path()
1556
if working_dir is not None:
1557
cwd = osutils.getcwd()
1558
os.chdir(working_dir)
1561
# win32 subprocess doesn't support preexec_fn
1562
# so we will avoid using it on all platforms, just to
1563
# make sure the code path is used, and we don't break on win32
1564
cleanup_environment()
1565
command = [sys.executable, bzr_path]
1566
if not allow_plugins:
1567
command.append('--no-plugins')
1568
command.extend(process_args)
1569
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1571
restore_environment()
1577
def _popen(self, *args, **kwargs):
1578
"""Place a call to Popen.
1580
Allows tests to override this method to intercept the calls made to
1581
Popen for introspection.
1583
return Popen(*args, **kwargs)
1585
def get_bzr_path(self):
1586
"""Return the path of the 'bzr' executable for this test suite."""
1587
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1588
if not os.path.isfile(bzr_path):
1589
# We are probably installed. Assume sys.argv is the right file
1590
bzr_path = sys.argv[0]
1593
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1594
universal_newlines=False, process_args=None):
1595
"""Finish the execution of process.
1597
:param process: the Popen object returned from start_bzr_subprocess.
1598
:param retcode: The status code that is expected. Defaults to 0. If
1599
None is supplied, the status code is not checked.
1600
:param send_signal: an optional signal to send to the process.
1601
:param universal_newlines: Convert CRLF => LF
1602
:returns: (stdout, stderr)
1604
if send_signal is not None:
1605
os.kill(process.pid, send_signal)
1606
out, err = process.communicate()
1608
if universal_newlines:
1609
out = out.replace('\r\n', '\n')
1610
err = err.replace('\r\n', '\n')
1612
if retcode is not None and retcode != process.returncode:
1613
if process_args is None:
1614
process_args = "(unknown args)"
1615
mutter('Output of bzr %s:\n%s', process_args, out)
1616
mutter('Error for bzr %s:\n%s', process_args, err)
1617
self.fail('Command bzr %s failed with retcode %s != %s'
1618
% (process_args, retcode, process.returncode))
1621
def check_inventory_shape(self, inv, shape):
1622
"""Compare an inventory to a list of expected names.
1624
Fail if they are not precisely equal.
1627
shape = list(shape) # copy
1628
for path, ie in inv.entries():
1629
name = path.replace('\\', '/')
1630
if ie.kind == 'directory':
1637
self.fail("expected paths not found in inventory: %r" % shape)
1639
self.fail("unexpected paths found in inventory: %r" % extras)
1641
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1642
a_callable=None, *args, **kwargs):
1643
"""Call callable with redirected std io pipes.
1645
Returns the return code."""
1646
if not callable(a_callable):
1647
raise ValueError("a_callable must be callable.")
1649
stdin = StringIO("")
1651
if getattr(self, "_log_file", None) is not None:
1652
stdout = self._log_file
1656
if getattr(self, "_log_file", None is not None):
1657
stderr = self._log_file
1660
real_stdin = sys.stdin
1661
real_stdout = sys.stdout
1662
real_stderr = sys.stderr
1667
return a_callable(*args, **kwargs)
1669
sys.stdout = real_stdout
1670
sys.stderr = real_stderr
1671
sys.stdin = real_stdin
1673
def reduceLockdirTimeout(self):
1674
"""Reduce the default lock timeout for the duration of the test, so that
1675
if LockContention occurs during a test, it does so quickly.
1677
Tests that expect to provoke LockContention errors should call this.
1679
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1681
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1682
self.addCleanup(resetTimeout)
1683
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1685
def make_utf8_encoded_stringio(self, encoding_type=None):
1686
"""Return a StringIOWrapper instance, that will encode Unicode
1689
if encoding_type is None:
1690
encoding_type = 'strict'
1692
output_encoding = 'utf-8'
1693
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1694
sio.encoding = output_encoding
1698
class TestCaseWithMemoryTransport(TestCase):
1699
"""Common test class for tests that do not need disk resources.
1701
Tests that need disk resources should derive from TestCaseWithTransport.
1703
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1705
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1706
a directory which does not exist. This serves to help ensure test isolation
1707
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1708
must exist. However, TestCaseWithMemoryTransport does not offer local
1709
file defaults for the transport in tests, nor does it obey the command line
1710
override, so tests that accidentally write to the common directory should
1713
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1714
a .bzr directory that stops us ascending higher into the filesystem.
1720
def __init__(self, methodName='runTest'):
1721
# allow test parameterisation after test construction and before test
1722
# execution. Variables that the parameteriser sets need to be
1723
# ones that are not set by setUp, or setUp will trash them.
1724
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1725
self.vfs_transport_factory = default_transport
1726
self.transport_server = None
1727
self.transport_readonly_server = None
1728
self.__vfs_server = None
1730
def get_transport(self, relpath=None):
1731
"""Return a writeable transport.
1733
This transport is for the test scratch space relative to
1736
:param relpath: a path relative to the base url.
1738
t = get_transport(self.get_url(relpath))
1739
self.assertFalse(t.is_readonly())
1742
def get_readonly_transport(self, relpath=None):
1743
"""Return a readonly transport for the test scratch space
1745
This can be used to test that operations which should only need
1746
readonly access in fact do not try to write.
1748
:param relpath: a path relative to the base url.
1750
t = get_transport(self.get_readonly_url(relpath))
1751
self.assertTrue(t.is_readonly())
1754
def create_transport_readonly_server(self):
1755
"""Create a transport server from class defined at init.
1757
This is mostly a hook for daughter classes.
1759
return self.transport_readonly_server()
1761
def get_readonly_server(self):
1762
"""Get the server instance for the readonly transport
1764
This is useful for some tests with specific servers to do diagnostics.
1766
if self.__readonly_server is None:
1767
if self.transport_readonly_server is None:
1768
# readonly decorator requested
1769
# bring up the server
1770
self.__readonly_server = ReadonlyServer()
1771
self.__readonly_server.setUp(self.get_vfs_only_server())
1773
self.__readonly_server = self.create_transport_readonly_server()
1774
self.__readonly_server.setUp(self.get_vfs_only_server())
1775
self.addCleanup(self.__readonly_server.tearDown)
1776
return self.__readonly_server
1778
def get_readonly_url(self, relpath=None):
1779
"""Get a URL for the readonly transport.
1781
This will either be backed by '.' or a decorator to the transport
1782
used by self.get_url()
1783
relpath provides for clients to get a path relative to the base url.
1784
These should only be downwards relative, not upwards.
1786
base = self.get_readonly_server().get_url()
1787
return self._adjust_url(base, relpath)
1789
def get_vfs_only_server(self):
1790
"""Get the vfs only read/write server instance.
1792
This is useful for some tests with specific servers that need
1795
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1796
is no means to override it.
1798
if self.__vfs_server is None:
1799
self.__vfs_server = MemoryServer()
1800
self.__vfs_server.setUp()
1801
self.addCleanup(self.__vfs_server.tearDown)
1802
return self.__vfs_server
1804
def get_server(self):
1805
"""Get the read/write server instance.
1807
This is useful for some tests with specific servers that need
1810
This is built from the self.transport_server factory. If that is None,
1811
then the self.get_vfs_server is returned.
1813
if self.__server is None:
1814
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1815
return self.get_vfs_only_server()
1817
# bring up a decorated means of access to the vfs only server.
1818
self.__server = self.transport_server()
1820
self.__server.setUp(self.get_vfs_only_server())
1821
except TypeError, e:
1822
# This should never happen; the try:Except here is to assist
1823
# developers having to update code rather than seeing an
1824
# uninformative TypeError.
1825
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1826
self.addCleanup(self.__server.tearDown)
1827
return self.__server
1829
def _adjust_url(self, base, relpath):
1830
"""Get a URL (or maybe a path) for the readwrite transport.
1832
This will either be backed by '.' or to an equivalent non-file based
1834
relpath provides for clients to get a path relative to the base url.
1835
These should only be downwards relative, not upwards.
1837
if relpath is not None and relpath != '.':
1838
if not base.endswith('/'):
1840
# XXX: Really base should be a url; we did after all call
1841
# get_url()! But sometimes it's just a path (from
1842
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1843
# to a non-escaped local path.
1844
if base.startswith('./') or base.startswith('/'):
1847
base += urlutils.escape(relpath)
1850
def get_url(self, relpath=None):
1851
"""Get a URL (or maybe a path) for the readwrite transport.
1853
This will either be backed by '.' or to an equivalent non-file based
1855
relpath provides for clients to get a path relative to the base url.
1856
These should only be downwards relative, not upwards.
1858
base = self.get_server().get_url()
1859
return self._adjust_url(base, relpath)
1861
def get_vfs_only_url(self, relpath=None):
1862
"""Get a URL (or maybe a path for the plain old vfs transport.
1864
This will never be a smart protocol. It always has all the
1865
capabilities of the local filesystem, but it might actually be a
1866
MemoryTransport or some other similar virtual filesystem.
1868
This is the backing transport (if any) of the server returned by
1869
get_url and get_readonly_url.
1871
:param relpath: provides for clients to get a path relative to the base
1872
url. These should only be downwards relative, not upwards.
1875
base = self.get_vfs_only_server().get_url()
1876
return self._adjust_url(base, relpath)
1878
def _make_test_root(self):
1879
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1881
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1882
TestCaseWithMemoryTransport.TEST_ROOT = root
1884
# make a fake bzr directory there to prevent any tests propagating
1885
# up onto the source directory's real branch
1886
bzrdir.BzrDir.create_standalone_workingtree(root)
1888
# The same directory is used by all tests, and we're not specifically
1889
# told when all tests are finished. This will do.
1890
atexit.register(_rmtree_temp_dir, root)
1892
def makeAndChdirToTestDir(self):
1893
"""Create a temporary directories for this one test.
1895
This must set self.test_home_dir and self.test_dir and chdir to
1898
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1900
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1901
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1902
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1904
def make_branch(self, relpath, format=None):
1905
"""Create a branch on the transport at relpath."""
1906
repo = self.make_repository(relpath, format=format)
1907
return repo.bzrdir.create_branch()
1909
def make_bzrdir(self, relpath, format=None):
1911
# might be a relative or absolute path
1912
maybe_a_url = self.get_url(relpath)
1913
segments = maybe_a_url.rsplit('/', 1)
1914
t = get_transport(maybe_a_url)
1915
if len(segments) > 1 and segments[-1] not in ('', '.'):
1919
if isinstance(format, basestring):
1920
format = bzrdir.format_registry.make_bzrdir(format)
1921
return format.initialize_on_transport(t)
1922
except errors.UninitializableFormat:
1923
raise TestSkipped("Format %s is not initializable." % format)
1925
def make_repository(self, relpath, shared=False, format=None):
1926
"""Create a repository on our default transport at relpath.
1928
Note that relpath must be a relative path, not a full url.
1930
# FIXME: If you create a remoterepository this returns the underlying
1931
# real format, which is incorrect. Actually we should make sure that
1932
# RemoteBzrDir returns a RemoteRepository.
1933
# maybe mbp 20070410
1934
made_control = self.make_bzrdir(relpath, format=format)
1935
return made_control.create_repository(shared=shared)
1937
def make_branch_and_memory_tree(self, relpath, format=None):
1938
"""Create a branch on the default transport and a MemoryTree for it."""
1939
b = self.make_branch(relpath, format=format)
1940
return memorytree.MemoryTree.create_on_branch(b)
1942
def overrideEnvironmentForTesting(self):
1943
os.environ['HOME'] = self.test_home_dir
1944
os.environ['BZR_HOME'] = self.test_home_dir
1947
super(TestCaseWithMemoryTransport, self).setUp()
1948
self._make_test_root()
1949
_currentdir = os.getcwdu()
1950
def _leaveDirectory():
1951
os.chdir(_currentdir)
1952
self.addCleanup(_leaveDirectory)
1953
self.makeAndChdirToTestDir()
1954
self.overrideEnvironmentForTesting()
1955
self.__readonly_server = None
1956
self.__server = None
1957
self.reduceLockdirTimeout()
1960
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1961
"""Derived class that runs a test within a temporary directory.
1963
This is useful for tests that need to create a branch, etc.
1965
The directory is created in a slightly complex way: for each
1966
Python invocation, a new temporary top-level directory is created.
1967
All test cases create their own directory within that. If the
1968
tests complete successfully, the directory is removed.
1970
:ivar test_base_dir: The path of the top-level directory for this
1971
test, which contains a home directory and a work directory.
1973
:ivar test_home_dir: An initially empty directory under test_base_dir
1974
which is used as $HOME for this test.
1976
:ivar test_dir: A directory under test_base_dir used as the current
1977
directory when the test proper is run.
1980
OVERRIDE_PYTHON = 'python'
1982
def check_file_contents(self, filename, expect):
1983
self.log("check contents of file %s" % filename)
1984
contents = file(filename, 'r').read()
1985
if contents != expect:
1986
self.log("expected: %r" % expect)
1987
self.log("actually: %r" % contents)
1988
self.fail("contents of %s not as expected" % filename)
1990
def makeAndChdirToTestDir(self):
1991
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1993
For TestCaseInTempDir we create a temporary directory based on the test
1994
name and then create two subdirs - test and home under it.
1996
# create a directory within the top level test directory
1997
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1998
# now create test and home directories within this dir
1999
self.test_base_dir = candidate_dir
2000
self.test_home_dir = self.test_base_dir + '/home'
2001
os.mkdir(self.test_home_dir)
2002
self.test_dir = self.test_base_dir + '/work'
2003
os.mkdir(self.test_dir)
2004
os.chdir(self.test_dir)
2005
# put name of test inside
2006
f = file(self.test_base_dir + '/name', 'w')
2011
self.addCleanup(self.deleteTestDir)
2013
def deleteTestDir(self):
2014
os.chdir(self.TEST_ROOT)
2015
_rmtree_temp_dir(self.test_base_dir)
2017
def build_tree(self, shape, line_endings='binary', transport=None):
2018
"""Build a test tree according to a pattern.
2020
shape is a sequence of file specifications. If the final
2021
character is '/', a directory is created.
2023
This assumes that all the elements in the tree being built are new.
2025
This doesn't add anything to a branch.
2027
:param line_endings: Either 'binary' or 'native'
2028
in binary mode, exact contents are written in native mode, the
2029
line endings match the default platform endings.
2030
:param transport: A transport to write to, for building trees on VFS's.
2031
If the transport is readonly or None, "." is opened automatically.
2034
# It's OK to just create them using forward slashes on windows.
2035
if transport is None or transport.is_readonly():
2036
transport = get_transport(".")
2038
self.assert_(isinstance(name, basestring))
2040
transport.mkdir(urlutils.escape(name[:-1]))
2042
if line_endings == 'binary':
2044
elif line_endings == 'native':
2047
raise errors.BzrError(
2048
'Invalid line ending request %r' % line_endings)
2049
content = "contents of %s%s" % (name.encode('utf-8'), end)
2050
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2052
def build_tree_contents(self, shape):
2053
build_tree_contents(shape)
2055
def assertFileEqual(self, content, path):
2056
"""Fail if path does not contain 'content'."""
2057
self.failUnlessExists(path)
2058
f = file(path, 'rb')
2063
self.assertEqualDiff(content, s)
2065
def failUnlessExists(self, path):
2066
"""Fail unless path or paths, which may be abs or relative, exist."""
2067
if not isinstance(path, basestring):
2069
self.failUnlessExists(p)
2071
self.failUnless(osutils.lexists(path),path+" does not exist")
2073
def failIfExists(self, path):
2074
"""Fail if path or paths, which may be abs or relative, exist."""
2075
if not isinstance(path, basestring):
2077
self.failIfExists(p)
2079
self.failIf(osutils.lexists(path),path+" exists")
2081
def assertInWorkingTree(self, path, root_path='.', tree=None):
2082
"""Assert whether path or paths are in the WorkingTree"""
2084
tree = workingtree.WorkingTree.open(root_path)
2085
if not isinstance(path, basestring):
2087
self.assertInWorkingTree(p,tree=tree)
2089
self.assertIsNot(tree.path2id(path), None,
2090
path+' not in working tree.')
2092
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2093
"""Assert whether path or paths are not in the WorkingTree"""
2095
tree = workingtree.WorkingTree.open(root_path)
2096
if not isinstance(path, basestring):
2098
self.assertNotInWorkingTree(p,tree=tree)
2100
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2103
class TestCaseWithTransport(TestCaseInTempDir):
2104
"""A test case that provides get_url and get_readonly_url facilities.
2106
These back onto two transport servers, one for readonly access and one for
2109
If no explicit class is provided for readonly access, a
2110
ReadonlyTransportDecorator is used instead which allows the use of non disk
2111
based read write transports.
2113
If an explicit class is provided for readonly access, that server and the
2114
readwrite one must both define get_url() as resolving to os.getcwd().
2117
def get_vfs_only_server(self):
2118
"""See TestCaseWithMemoryTransport.
2120
This is useful for some tests with specific servers that need
2123
if self.__vfs_server is None:
2124
self.__vfs_server = self.vfs_transport_factory()
2125
self.__vfs_server.setUp()
2126
self.addCleanup(self.__vfs_server.tearDown)
2127
return self.__vfs_server
2129
def make_branch_and_tree(self, relpath, format=None):
2130
"""Create a branch on the transport and a tree locally.
2132
If the transport is not a LocalTransport, the Tree can't be created on
2133
the transport. In that case if the vfs_transport_factory is
2134
LocalURLServer the working tree is created in the local
2135
directory backing the transport, and the returned tree's branch and
2136
repository will also be accessed locally. Otherwise a lightweight
2137
checkout is created and returned.
2139
:param format: The BzrDirFormat.
2140
:returns: the WorkingTree.
2142
# TODO: always use the local disk path for the working tree,
2143
# this obviously requires a format that supports branch references
2144
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2146
b = self.make_branch(relpath, format=format)
2148
return b.bzrdir.create_workingtree()
2149
except errors.NotLocalUrl:
2150
# We can only make working trees locally at the moment. If the
2151
# transport can't support them, then we keep the non-disk-backed
2152
# branch and create a local checkout.
2153
if self.vfs_transport_factory is LocalURLServer:
2154
# the branch is colocated on disk, we cannot create a checkout.
2155
# hopefully callers will expect this.
2156
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2157
return local_controldir.create_workingtree()
2159
return b.create_checkout(relpath, lightweight=True)
2161
def assertIsDirectory(self, relpath, transport):
2162
"""Assert that relpath within transport is a directory.
2164
This may not be possible on all transports; in that case it propagates
2165
a TransportNotPossible.
2168
mode = transport.stat(relpath).st_mode
2169
except errors.NoSuchFile:
2170
self.fail("path %s is not a directory; no such file"
2172
if not stat.S_ISDIR(mode):
2173
self.fail("path %s is not a directory; has mode %#o"
2176
def assertTreesEqual(self, left, right):
2177
"""Check that left and right have the same content and properties."""
2178
# we use a tree delta to check for equality of the content, and we
2179
# manually check for equality of other things such as the parents list.
2180
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2181
differences = left.changes_from(right)
2182
self.assertFalse(differences.has_changed(),
2183
"Trees %r and %r are different: %r" % (left, right, differences))
2186
super(TestCaseWithTransport, self).setUp()
2187
self.__vfs_server = None
2190
class ChrootedTestCase(TestCaseWithTransport):
2191
"""A support class that provides readonly urls outside the local namespace.
2193
This is done by checking if self.transport_server is a MemoryServer. if it
2194
is then we are chrooted already, if it is not then an HttpServer is used
2197
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2198
be used without needed to redo it when a different
2199
subclass is in use ?
2203
super(ChrootedTestCase, self).setUp()
2204
if not self.vfs_transport_factory == MemoryServer:
2205
self.transport_readonly_server = HttpServer
2208
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2209
random_order=False):
2210
"""Create a test suite by filtering another one.
2212
:param suite: the source suite
2213
:param pattern: pattern that names must match
2214
:param exclude_pattern: pattern that names must not match, if any
2215
:param random_order: if True, tests in the new suite will be put in
2217
:returns: the newly created suite
2219
return sort_suite_by_re(suite, pattern, exclude_pattern,
2220
random_order, False)
2223
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2224
random_order=False, append_rest=True):
2225
"""Create a test suite by sorting another one.
2227
:param suite: the source suite
2228
:param pattern: pattern that names must match in order to go
2229
first in the new suite
2230
:param exclude_pattern: pattern that names must not match, if any
2231
:param random_order: if True, tests in the new suite will be put in
2233
:param append_rest: if False, pattern is a strict filter and not
2234
just an ordering directive
2235
:returns: the newly created suite
2239
filter_re = re.compile(pattern)
2240
if exclude_pattern is not None:
2241
exclude_re = re.compile(exclude_pattern)
2242
for test in iter_suite_tests(suite):
2244
if exclude_pattern is None or not exclude_re.search(test_id):
2245
if filter_re.search(test_id):
2250
random.shuffle(first)
2251
random.shuffle(second)
2252
return TestUtil.TestSuite(first + second)
2255
def run_suite(suite, name='test', verbose=False, pattern=".*",
2256
stop_on_failure=False,
2257
transport=None, lsprof_timed=None, bench_history=None,
2258
matching_tests_first=None,
2261
exclude_pattern=None,
62
if m not in MODULES_TO_TEST:
63
MODULES_TO_TEST.append(m)
66
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
67
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
2264
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2269
runner = TextTestRunner(stream=sys.stdout,
2271
verbosity=verbosity,
2272
bench_history=bench_history,
2273
list_only=list_only,
2275
runner.stop_on_failure=stop_on_failure
2276
# Initialise the random number generator and display the seed used.
2277
# We convert the seed to a long to make it reuseable across invocations.
2278
random_order = False
2279
if random_seed is not None:
2281
if random_seed == "now":
2282
random_seed = long(time.time())
2284
# Convert the seed to a long if we can
2286
random_seed = long(random_seed)
2289
runner.stream.writeln("Randomizing test order using seed %s\n" %
2291
random.seed(random_seed)
2292
# Customise the list of tests if requested
2293
if pattern != '.*' or exclude_pattern is not None or random_order:
2294
if matching_tests_first:
2295
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2298
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2300
result = runner.run(suite)
2303
return result.wasStrictlySuccessful()
2305
return result.wasSuccessful()
2308
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2310
test_suite_factory=None,
2313
matching_tests_first=None,
2316
exclude_pattern=None,
2319
"""Run the whole test suite under the enhanced runner"""
2320
# XXX: Very ugly way to do this...
2321
# Disable warning about old formats because we don't want it to disturb
2322
# any blackbox tests.
2323
from bzrlib import repository
2324
repository._deprecation_warning_done = True
2326
global default_transport
2327
if transport is None:
2328
transport = default_transport
2329
old_transport = default_transport
2330
default_transport = transport
2332
if test_suite_factory is None:
2333
suite = test_suite()
2335
suite = test_suite_factory()
2336
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2337
stop_on_failure=stop_on_failure,
2338
transport=transport,
2339
lsprof_timed=lsprof_timed,
2340
bench_history=bench_history,
2341
matching_tests_first=matching_tests_first,
2342
list_only=list_only,
2343
random_seed=random_seed,
2344
exclude_pattern=exclude_pattern,
2347
default_transport = old_transport
2351
"""Build and return TestSuite for the whole of bzrlib.
2353
This function can be replaced if you need to change the default test
2354
suite on a global basis, but it is not encouraged.
2357
'bzrlib.util.tests.test_bencode',
2358
'bzrlib.tests.test__dirstate_helpers',
2359
'bzrlib.tests.test_ancestry',
2360
'bzrlib.tests.test_annotate',
2361
'bzrlib.tests.test_api',
2362
'bzrlib.tests.test_atomicfile',
2363
'bzrlib.tests.test_bad_files',
2364
'bzrlib.tests.test_branch',
2365
'bzrlib.tests.test_branchbuilder',
2366
'bzrlib.tests.test_bugtracker',
2367
'bzrlib.tests.test_bundle',
2368
'bzrlib.tests.test_bzrdir',
2369
'bzrlib.tests.test_cache_utf8',
2370
'bzrlib.tests.test_commands',
2371
'bzrlib.tests.test_commit',
2372
'bzrlib.tests.test_commit_merge',
2373
'bzrlib.tests.test_config',
2374
'bzrlib.tests.test_conflicts',
2375
'bzrlib.tests.test_counted_lock',
2376
'bzrlib.tests.test_decorators',
2377
'bzrlib.tests.test_delta',
2378
'bzrlib.tests.test_deprecated_graph',
2379
'bzrlib.tests.test_diff',
2380
'bzrlib.tests.test_dirstate',
2381
'bzrlib.tests.test_email_message',
2382
'bzrlib.tests.test_errors',
2383
'bzrlib.tests.test_escaped_store',
2384
'bzrlib.tests.test_extract',
2385
'bzrlib.tests.test_fetch',
2386
'bzrlib.tests.test_ftp_transport',
2387
'bzrlib.tests.test_generate_docs',
2388
'bzrlib.tests.test_generate_ids',
2389
'bzrlib.tests.test_globbing',
2390
'bzrlib.tests.test_gpg',
2391
'bzrlib.tests.test_graph',
2392
'bzrlib.tests.test_hashcache',
2393
'bzrlib.tests.test_help',
2394
'bzrlib.tests.test_hooks',
2395
'bzrlib.tests.test_http',
2396
'bzrlib.tests.test_http_response',
2397
'bzrlib.tests.test_https_ca_bundle',
2398
'bzrlib.tests.test_identitymap',
2399
'bzrlib.tests.test_ignores',
2400
'bzrlib.tests.test_index',
2401
'bzrlib.tests.test_info',
2402
'bzrlib.tests.test_inv',
2403
'bzrlib.tests.test_knit',
2404
'bzrlib.tests.test_lazy_import',
2405
'bzrlib.tests.test_lazy_regex',
2406
'bzrlib.tests.test_lockdir',
2407
'bzrlib.tests.test_lockable_files',
2408
'bzrlib.tests.test_log',
2409
'bzrlib.tests.test_lsprof',
2410
'bzrlib.tests.test_mail_client',
2411
'bzrlib.tests.test_memorytree',
2412
'bzrlib.tests.test_merge',
2413
'bzrlib.tests.test_merge3',
2414
'bzrlib.tests.test_merge_core',
2415
'bzrlib.tests.test_merge_directive',
2416
'bzrlib.tests.test_missing',
2417
'bzrlib.tests.test_msgeditor',
2418
'bzrlib.tests.test_multiparent',
2419
'bzrlib.tests.test_nonascii',
2420
'bzrlib.tests.test_options',
2421
'bzrlib.tests.test_osutils',
2422
'bzrlib.tests.test_osutils_encodings',
2423
'bzrlib.tests.test_pack',
2424
'bzrlib.tests.test_patch',
2425
'bzrlib.tests.test_patches',
2426
'bzrlib.tests.test_permissions',
2427
'bzrlib.tests.test_plugins',
2428
'bzrlib.tests.test_progress',
2429
'bzrlib.tests.test_reconcile',
2430
'bzrlib.tests.test_registry',
2431
'bzrlib.tests.test_remote',
2432
'bzrlib.tests.test_repository',
2433
'bzrlib.tests.test_revert',
2434
'bzrlib.tests.test_revision',
2435
'bzrlib.tests.test_revisionnamespaces',
2436
'bzrlib.tests.test_revisiontree',
2437
'bzrlib.tests.test_rio',
2438
'bzrlib.tests.test_sampler',
2439
'bzrlib.tests.test_selftest',
2440
'bzrlib.tests.test_setup',
2441
'bzrlib.tests.test_sftp_transport',
2442
'bzrlib.tests.test_smart',
2443
'bzrlib.tests.test_smart_add',
2444
'bzrlib.tests.test_smart_transport',
2445
'bzrlib.tests.test_smtp_connection',
2446
'bzrlib.tests.test_source',
2447
'bzrlib.tests.test_ssh_transport',
2448
'bzrlib.tests.test_status',
2449
'bzrlib.tests.test_store',
2450
'bzrlib.tests.test_strace',
2451
'bzrlib.tests.test_subsume',
2452
'bzrlib.tests.test_symbol_versioning',
2453
'bzrlib.tests.test_tag',
2454
'bzrlib.tests.test_testament',
2455
'bzrlib.tests.test_textfile',
2456
'bzrlib.tests.test_textmerge',
2457
'bzrlib.tests.test_timestamp',
2458
'bzrlib.tests.test_trace',
2459
'bzrlib.tests.test_transactions',
2460
'bzrlib.tests.test_transform',
2461
'bzrlib.tests.test_transport',
2462
'bzrlib.tests.test_tree',
2463
'bzrlib.tests.test_treebuilder',
2464
'bzrlib.tests.test_tsort',
2465
'bzrlib.tests.test_tuned_gzip',
2466
'bzrlib.tests.test_ui',
2467
'bzrlib.tests.test_upgrade',
2468
'bzrlib.tests.test_urlutils',
2469
'bzrlib.tests.test_versionedfile',
2470
'bzrlib.tests.test_version',
2471
'bzrlib.tests.test_version_info',
2472
'bzrlib.tests.test_weave',
2473
'bzrlib.tests.test_whitebox',
2474
'bzrlib.tests.test_win32utils',
2475
'bzrlib.tests.test_workingtree',
2476
'bzrlib.tests.test_workingtree_4',
2477
'bzrlib.tests.test_wsgi',
2478
'bzrlib.tests.test_xml',
2480
test_transport_implementations = [
2481
'bzrlib.tests.test_transport_implementations',
2482
'bzrlib.tests.test_read_bundle',
2484
suite = TestUtil.TestSuite()
2485
loader = TestUtil.TestLoader()
2486
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2487
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2488
adapter = TransportTestProviderAdapter()
2489
adapt_modules(test_transport_implementations, adapter, loader, suite)
2490
for package in packages_to_test():
2491
suite.addTest(package.test_suite())
2492
for m in MODULES_TO_TEST:
2493
suite.addTest(loader.loadTestsFromModule(m))
2494
for m in MODULES_TO_DOCTEST:
2496
suite.addTest(doctest.DocTestSuite(m))
2497
except ValueError, e:
2498
print '**failed to get doctest for: %s\n%s' %(m,e)
2500
default_encoding = sys.getdefaultencoding()
2501
for name, plugin in bzrlib.plugin.plugins().items():
2503
plugin_suite = plugin.test_suite()
2504
except ImportError, e:
2505
bzrlib.trace.warning(
2506
'Unable to test plugin "%s": %s', name, e)
2508
if plugin_suite is not None:
2509
suite.addTest(plugin_suite)
2510
if default_encoding != sys.getdefaultencoding():
2511
bzrlib.trace.warning(
2512
'Plugin "%s" tried to reset default encoding to: %s', name,
2513
sys.getdefaultencoding())
2515
sys.setdefaultencoding(default_encoding)
2519
def multiply_tests_from_modules(module_name_list, scenario_iter):
2520
"""Adapt all tests in some given modules to given scenarios.
2522
This is the recommended public interface for test parameterization.
2523
Typically the test_suite() method for a per-implementation test
2524
suite will call multiply_tests_from_modules and return the
2527
:param module_name_list: List of fully-qualified names of test
2529
:param scenario_iter: Iterable of pairs of (scenario_name,
2530
scenario_param_dict).
2532
This returns a new TestSuite containing the cross product of
2533
all the tests in all the modules, each repeated for each scenario.
2534
Each test is adapted by adding the scenario name at the end
2535
of its name, and updating the test object's __dict__ with the
2536
scenario_param_dict.
2538
>>> r = multiply_tests_from_modules(
2539
... ['bzrlib.tests.test_sampler'],
2540
... [('one', dict(param=1)),
2541
... ('two', dict(param=2))])
2542
>>> tests = list(iter_suite_tests(r))
2546
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2552
loader = TestLoader()
71
2553
suite = TestSuite()
73
# should also test bzrlib.merge_core, but they seem to be out of date with
77
# XXX: python2.3's TestLoader() doesn't seem to find all the
78
# tests; don't know why
79
for m in MODULES_TO_TEST:
80
suite.addTest(TestLoader().loadTestsFromModule(m))
82
for m in (MODULES_TO_DOCTEST):
83
suite.addTest(DocTestSuite(m))
85
for p in bzrlib.plugin.all_plugins:
86
if hasattr(p, 'test_suite'):
87
suite.addTest(p.test_suite())
89
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
91
return run_suite(suite, 'testbzr')
2554
adapter = TestScenarioApplier()
2555
adapter.scenarios = list(scenario_iter)
2556
adapt_modules(module_name_list, adapter, loader, suite)
2560
def adapt_modules(mods_list, adapter, loader, suite):
2561
"""Adapt the modules in mods_list using adapter and add to suite."""
2562
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2563
suite.addTests(adapter.adapt(test))
2566
def _rmtree_temp_dir(dirname):
2567
# If LANG=C we probably have created some bogus paths
2568
# which rmtree(unicode) will fail to delete
2569
# so make sure we are using rmtree(str) to delete everything
2570
# except on win32, where rmtree(str) will fail
2571
# since it doesn't have the property of byte-stream paths
2572
# (they are either ascii or mbcs)
2573
if sys.platform == 'win32':
2574
# make sure we are using the unicode win32 api
2575
dirname = unicode(dirname)
2577
dirname = dirname.encode(sys.getfilesystemencoding())
2579
osutils.rmtree(dirname)
2581
if sys.platform == 'win32' and e.errno == errno.EACCES:
2582
print >>sys.stderr, ('Permission denied: '
2583
'unable to remove testing dir '
2584
'%s' % os.path.basename(dirname))
2589
class Feature(object):
2590
"""An operating system Feature."""
2593
self._available = None
2595
def available(self):
2596
"""Is the feature available?
2598
:return: True if the feature is available.
2600
if self._available is None:
2601
self._available = self._probe()
2602
return self._available
2605
"""Implement this method in concrete features.
2607
:return: True if the feature is available.
2609
raise NotImplementedError
2612
if getattr(self, 'feature_name', None):
2613
return self.feature_name()
2614
return self.__class__.__name__
2617
class _SymlinkFeature(Feature):
2620
return osutils.has_symlinks()
2622
def feature_name(self):
2625
SymlinkFeature = _SymlinkFeature()
2628
class TestScenarioApplier(object):
2629
"""A tool to apply scenarios to tests."""
2631
def adapt(self, test):
2632
"""Return a TestSuite containing a copy of test for each scenario."""
2633
result = unittest.TestSuite()
2634
for scenario in self.scenarios:
2635
result.addTest(self.adapt_test_to_scenario(test, scenario))
2638
def adapt_test_to_scenario(self, test, scenario):
2639
"""Copy test and apply scenario to it.
2641
:param test: A test to adapt.
2642
:param scenario: A tuple describing the scenarion.
2643
The first element of the tuple is the new test id.
2644
The second element is a dict containing attributes to set on the
2646
:return: The adapted test.
2648
from copy import deepcopy
2649
new_test = deepcopy(test)
2650
for name, value in scenario[1].items():
2651
setattr(new_test, name, value)
2652
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2653
new_test.id = lambda: new_id
2657
def probe_unicode_in_user_encoding():
2658
"""Try to encode several unicode strings to use in unicode-aware tests.
2659
Return first successfull match.
2661
:return: (unicode value, encoded plain string value) or (None, None)
2663
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2664
for uni_val in possible_vals:
2666
str_val = uni_val.encode(bzrlib.user_encoding)
2667
except UnicodeEncodeError:
2668
# Try a different character
2671
return uni_val, str_val
added
removed
bzrlib/tests/__init__.py
