1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1
# Copyright (C) 2005 by 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
# 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.
30
18
from cStringIO import StringIO
36
from pprint import pformat
40
from subprocess import Popen, PIPE
58
31
import bzrlib.branch
59
32
import bzrlib.commands
60
import bzrlib.timestamp
33
from bzrlib.errors import BzrError
62
34
import bzrlib.inventory
63
import bzrlib.iterablefile
68
# lsprof not available
70
from bzrlib.merge import merge_inner
71
35
import bzrlib.merge3
72
36
import bzrlib.osutils
37
import bzrlib.osutils as osutils
73
38
import bzrlib.plugin
74
from bzrlib.revision import common_ancestor
75
39
import bzrlib.store
76
from bzrlib import symbol_versioning
77
40
import bzrlib.trace
78
from bzrlib.transport import get_transport
79
import bzrlib.transport
80
from bzrlib.transport.local import LocalURLServer
81
from bzrlib.transport.memory import MemoryServer
82
from bzrlib.transport.readonly import ReadonlyServer
83
from bzrlib.trace import mutter, note
84
from bzrlib.tests import TestUtil
85
from bzrlib.tests.HttpServer import HttpServer
86
from bzrlib.tests.TestUtil import (
41
from bzrlib.trace import mutter
42
from bzrlib.tests.TestUtil import TestLoader, TestSuite
90
43
from bzrlib.tests.treeshape import build_tree_contents
91
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
93
# Mark this python module as being part of the implementation
94
# of unittest: this gives us better tracebacks where the last
95
# shown frame is the test code, not our assertXYZ.
98
default_transport = LocalURLServer
100
45
MODULES_TO_TEST = []
101
46
MODULES_TO_DOCTEST = [
114
55
def packages_to_test():
115
"""Return a list of packages to test.
117
The packages are not globally imported so that import failures are
118
triggered when running selftest, not when importing the command.
121
56
import bzrlib.tests.blackbox
122
import bzrlib.tests.branch_implementations
123
import bzrlib.tests.bzrdir_implementations
124
import bzrlib.tests.interrepository_implementations
125
import bzrlib.tests.interversionedfile_implementations
126
import bzrlib.tests.intertree_implementations
127
import bzrlib.tests.per_lock
128
import bzrlib.tests.repository_implementations
129
import bzrlib.tests.revisionstore_implementations
130
import bzrlib.tests.tree_implementations
131
import bzrlib.tests.workingtree_implementations
134
bzrlib.tests.blackbox,
135
bzrlib.tests.branch_implementations,
136
bzrlib.tests.bzrdir_implementations,
137
bzrlib.tests.interrepository_implementations,
138
bzrlib.tests.interversionedfile_implementations,
139
bzrlib.tests.intertree_implementations,
140
bzrlib.tests.per_lock,
141
bzrlib.tests.repository_implementations,
142
bzrlib.tests.revisionstore_implementations,
143
bzrlib.tests.tree_implementations,
144
bzrlib.tests.workingtree_implementations,
148
class ExtendedTestResult(unittest._TextTestResult):
149
"""Accepts, reports and accumulates the results of running tests.
151
Compared to this unittest version this class adds support for profiling,
152
benchmarking, stopping as soon as a test fails, and skipping tests.
153
There are further-specialized subclasses for different types of display.
62
class EarlyStoppingTestResultAdapter(object):
63
"""An adapter for TestResult to stop at the first first failure or error"""
65
def __init__(self, result):
68
def addError(self, test, err):
69
self._result.addError(test, err)
72
def addFailure(self, test, err):
73
self._result.addFailure(test, err)
76
def __getattr__(self, name):
77
return getattr(self._result, name)
79
def __setattr__(self, name, value):
81
object.__setattr__(self, name, value)
82
return setattr(self._result, name, value)
85
class _MyResult(unittest._TextTestResult):
88
Shows output in a different format, including displaying runtime for tests.
158
def __init__(self, stream, descriptions, verbosity,
161
use_numbered_dirs=False,
163
"""Construct new TestResult.
165
:param bench_history: Optionally, a writable file object to accumulate
168
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
169
if bench_history is not None:
170
from bzrlib.version import _get_bzr_source_tree
171
src_tree = _get_bzr_source_tree()
174
revision_id = src_tree.get_parent_ids()[0]
176
# XXX: if this is a brand new tree, do the same as if there
180
# XXX: If there's no branch, what should we do?
182
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
183
self._bench_history = bench_history
184
self.ui = ui.ui_factory
185
self.num_tests = num_tests
187
self.failure_count = 0
188
self.known_failure_count = 0
190
self.unsupported = {}
192
self.use_numbered_dirs = use_numbered_dirs
193
self._overall_start_time = time.time()
195
def extractBenchmarkTime(self, testCase):
196
"""Add a benchmark time for the current test case."""
197
self._benchmarkTime = getattr(testCase, "_benchtime", None)
199
def _elapsedTestTimeString(self):
200
"""Return a time string for the overall time the current test has taken."""
201
return self._formatTime(time.time() - self._start_time)
203
def _testTimeString(self):
204
if self._benchmarkTime is not None:
206
self._formatTime(self._benchmarkTime),
207
self._elapsedTestTimeString())
209
return " %s" % self._elapsedTestTimeString()
211
def _formatTime(self, seconds):
212
"""Format seconds as milliseconds with leading spaces."""
213
# some benchmarks can take thousands of seconds to run, so we need 8
215
return "%8dms" % (1000 * seconds)
217
def _shortened_test_description(self, test):
219
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
91
def _elapsedTime(self):
92
return "%5dms" % (1000 * (time.time() - self._start_time))
222
94
def startTest(self, test):
223
95
unittest.TestResult.startTest(self, test)
224
self.report_test_start(test)
225
test.number = self.count
226
self._recordTestStartTime()
228
def _recordTestStartTime(self):
229
"""Record that a test has started."""
96
# In a short description, the important words are in
97
# the beginning, but in an id, the important words are
99
SHOW_DESCRIPTIONS = False
101
width = osutils.terminal_width()
102
name_width = width - 15
104
if SHOW_DESCRIPTIONS:
105
what = test.shortDescription()
107
if len(what) > name_width:
108
what = what[:name_width-3] + '...'
111
if what.startswith('bzrlib.tests.'):
113
if len(what) > name_width:
114
what = '...' + what[3-name_width:]
115
what = what.ljust(name_width)
116
self.stream.write(what)
230
118
self._start_time = time.time()
232
def _cleanupLogFile(self, test):
233
# We can only do this if we have one of our TestCases, not if
235
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
236
if setKeepLogfile is not None:
239
120
def addError(self, test, err):
240
self.extractBenchmarkTime(test)
241
self._cleanupLogFile(test)
242
if isinstance(err[1], TestSkipped):
243
return self.addSkipped(test, err)
244
elif isinstance(err[1], UnavailableFeature):
245
return self.addNotSupported(test, err[1].args[0])
246
121
unittest.TestResult.addError(self, test, err)
247
self.error_count += 1
248
self.report_error(test, err)
123
self.stream.writeln("ERROR %s" % self._elapsedTime())
125
self.stream.write('E')
252
128
def addFailure(self, test, err):
253
self._cleanupLogFile(test)
254
self.extractBenchmarkTime(test)
255
if isinstance(err[1], KnownFailure):
256
return self.addKnownFailure(test, err)
257
129
unittest.TestResult.addFailure(self, test, err)
258
self.failure_count += 1
259
self.report_failure(test, err)
263
def addKnownFailure(self, test, err):
264
self.known_failure_count += 1
265
self.report_known_failure(test, err)
267
def addNotSupported(self, test, feature):
268
self.unsupported.setdefault(str(feature), 0)
269
self.unsupported[str(feature)] += 1
270
self.report_unsupported(test, feature)
131
self.stream.writeln(" FAIL %s" % self._elapsedTime())
133
self.stream.write('F')
272
136
def addSuccess(self, test):
273
self.extractBenchmarkTime(test)
274
if self._bench_history is not None:
275
if self._benchmarkTime is not None:
276
self._bench_history.write("%s %s\n" % (
277
self._formatTime(self._benchmarkTime),
279
self.report_success(test)
138
self.stream.writeln(' OK %s' % self._elapsedTime())
140
self.stream.write('~')
280
142
unittest.TestResult.addSuccess(self, test)
282
def addSkipped(self, test, skip_excinfo):
283
self.report_skip(test, skip_excinfo)
284
# seems best to treat this as success from point-of-view of unittest
285
# -- it actually does nothing so it barely matters :)
288
except KeyboardInterrupt:
291
self.addError(test, test.__exc_info())
293
unittest.TestResult.addSuccess(self, test)
295
144
def printErrorList(self, flavour, errors):
296
145
for test, err in errors:
297
146
self.stream.writeln(self.separator1)
298
self.stream.write("%s: " % flavour)
299
if self.use_numbered_dirs:
300
self.stream.write('#%d ' % test.number)
301
self.stream.writeln(self.getDescription(test))
302
if getattr(test, '_get_log', None) is not None:
304
print >>self.stream, \
305
('vvvv[log from %s]' % test.id()).ljust(78,'-')
147
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
148
if hasattr(test, '_get_log'):
149
self.stream.writeln()
150
self.stream.writeln('log from this test:')
306
151
print >>self.stream, test._get_log()
307
print >>self.stream, \
308
('^^^^[log from %s]' % test.id()).ljust(78,'-')
309
152
self.stream.writeln(self.separator2)
310
153
self.stream.writeln("%s" % err)
315
def report_cleaning_up(self):
318
def report_success(self, test):
322
class TextTestResult(ExtendedTestResult):
323
"""Displays progress and results of tests in text form"""
325
def __init__(self, stream, descriptions, verbosity,
329
use_numbered_dirs=False,
331
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
332
bench_history, num_tests, use_numbered_dirs)
334
self.pb = self.ui.nested_progress_bar()
335
self._supplied_pb = False
338
self._supplied_pb = True
339
self.pb.show_pct = False
340
self.pb.show_spinner = False
341
self.pb.show_eta = False,
342
self.pb.show_count = False
343
self.pb.show_bar = False
345
def report_starting(self):
346
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
348
def _progress_prefix_text(self):
349
a = '[%d' % self.count
350
if self.num_tests is not None:
351
a +='/%d' % self.num_tests
352
a += ' in %ds' % (time.time() - self._overall_start_time)
354
a += ', %d errors' % self.error_count
355
if self.failure_count:
356
a += ', %d failed' % self.failure_count
357
if self.known_failure_count:
358
a += ', %d known failures' % self.known_failure_count
360
a += ', %d skipped' % self.skip_count
362
a += ', %d missing features' % len(self.unsupported)
366
def report_test_start(self, test):
369
self._progress_prefix_text()
371
+ self._shortened_test_description(test))
373
def _test_description(self, test):
374
if self.use_numbered_dirs:
375
return '#%d %s' % (self.count,
376
self._shortened_test_description(test))
378
return self._shortened_test_description(test)
380
def report_error(self, test, err):
381
self.pb.note('ERROR: %s\n %s\n',
382
self._test_description(test),
386
def report_failure(self, test, err):
387
self.pb.note('FAIL: %s\n %s\n',
388
self._test_description(test),
392
def report_known_failure(self, test, err):
393
self.pb.note('XFAIL: %s\n%s\n',
394
self._test_description(test), err[1])
396
def report_skip(self, test, skip_excinfo):
399
# at the moment these are mostly not things we can fix
400
# and so they just produce stipple; use the verbose reporter
403
# show test and reason for skip
404
self.pb.note('SKIP: %s\n %s\n',
405
self._shortened_test_description(test),
408
# since the class name was left behind in the still-visible
410
self.pb.note('SKIP: %s', skip_excinfo[1])
412
def report_unsupported(self, test, feature):
413
"""test cannot be run because feature is missing."""
415
def report_cleaning_up(self):
416
self.pb.update('cleaning up...')
419
if not self._supplied_pb:
423
class VerboseTestResult(ExtendedTestResult):
424
"""Produce long output, with one line per test run plus times"""
426
def _ellipsize_to_right(self, a_string, final_width):
427
"""Truncate and pad a string, keeping the right hand side"""
428
if len(a_string) > final_width:
429
result = '...' + a_string[3-final_width:]
432
return result.ljust(final_width)
434
def report_starting(self):
435
self.stream.write('running %d tests...\n' % self.num_tests)
437
def report_test_start(self, test):
439
name = self._shortened_test_description(test)
440
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
441
# numbers, plus a trailing blank
442
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
443
if self.use_numbered_dirs:
444
self.stream.write('%5d ' % self.count)
445
self.stream.write(self._ellipsize_to_right(name,
446
osutils.terminal_width()-36))
448
self.stream.write(self._ellipsize_to_right(name,
449
osutils.terminal_width()-30))
452
def _error_summary(self, err):
454
if self.use_numbered_dirs:
456
return '%s%s' % (indent, err[1])
458
def report_error(self, test, err):
459
self.stream.writeln('ERROR %s\n%s'
460
% (self._testTimeString(),
461
self._error_summary(err)))
463
def report_failure(self, test, err):
464
self.stream.writeln(' FAIL %s\n%s'
465
% (self._testTimeString(),
466
self._error_summary(err)))
468
def report_known_failure(self, test, err):
469
self.stream.writeln('XFAIL %s\n%s'
470
% (self._testTimeString(),
471
self._error_summary(err)))
473
def report_success(self, test):
474
self.stream.writeln(' OK %s' % self._testTimeString())
475
for bench_called, stats in getattr(test, '_benchcalls', []):
476
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
477
stats.pprint(file=self.stream)
478
# flush the stream so that we get smooth output. This verbose mode is
479
# used to show the output in PQM.
482
def report_skip(self, test, skip_excinfo):
484
self.stream.writeln(' SKIP %s\n%s'
485
% (self._testTimeString(),
486
self._error_summary(skip_excinfo)))
488
def report_unsupported(self, test, feature):
489
"""test cannot be run because feature is missing."""
490
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
491
%(self._testTimeString(), feature))
495
class TextTestRunner(object):
156
class TextTestRunner(unittest.TextTestRunner):
496
157
stop_on_failure = False
504
use_numbered_dirs=False,
507
self.stream = unittest._WritelnDecorator(stream)
508
self.descriptions = descriptions
509
self.verbosity = verbosity
510
self.keep_output = keep_output
511
self._bench_history = bench_history
512
self.use_numbered_dirs = use_numbered_dirs
513
self.list_only = list_only
516
"Run the given test case or test suite."
517
startTime = time.time()
518
if self.verbosity == 1:
519
result_class = TextTestResult
520
elif self.verbosity >= 2:
521
result_class = VerboseTestResult
522
result = result_class(self.stream,
525
bench_history=self._bench_history,
526
num_tests=test.countTestCases(),
527
use_numbered_dirs=self.use_numbered_dirs,
529
result.stop_early = self.stop_on_failure
530
result.report_starting()
532
if self.verbosity >= 2:
533
self.stream.writeln("Listing tests only ...\n")
535
for t in iter_suite_tests(test):
536
self.stream.writeln("%s" % (t.id()))
538
actionTaken = "Listed"
541
run = result.testsRun
543
stopTime = time.time()
544
timeTaken = stopTime - startTime
546
self.stream.writeln(result.separator2)
547
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
548
run, run != 1 and "s" or "", timeTaken))
549
self.stream.writeln()
550
if not result.wasSuccessful():
551
self.stream.write("FAILED (")
552
failed, errored = map(len, (result.failures, result.errors))
554
self.stream.write("failures=%d" % failed)
556
if failed: self.stream.write(", ")
557
self.stream.write("errors=%d" % errored)
558
if result.known_failure_count:
559
if failed or errored: self.stream.write(", ")
560
self.stream.write("known_failure_count=%d" %
561
result.known_failure_count)
562
self.stream.writeln(")")
564
if result.known_failure_count:
565
self.stream.writeln("OK (known_failures=%d)" %
566
result.known_failure_count)
568
self.stream.writeln("OK")
569
if result.skip_count > 0:
570
skipped = result.skip_count
571
self.stream.writeln('%d test%s skipped' %
572
(skipped, skipped != 1 and "s" or ""))
573
if result.unsupported:
574
for feature, count in sorted(result.unsupported.items()):
575
self.stream.writeln("Missing feature '%s' skipped %d tests." %
577
result.report_cleaning_up()
578
# This is still a little bogus,
579
# but only a little. Folk not using our testrunner will
580
# have to delete their temp directories themselves.
581
test_root = TestCaseWithMemoryTransport.TEST_ROOT
582
if result.wasSuccessful() or not self.keep_output:
583
if test_root is not None:
584
# If LANG=C we probably have created some bogus paths
585
# which rmtree(unicode) will fail to delete
586
# so make sure we are using rmtree(str) to delete everything
587
# except on win32, where rmtree(str) will fail
588
# since it doesn't have the property of byte-stream paths
589
# (they are either ascii or mbcs)
590
if sys.platform == 'win32':
591
# make sure we are using the unicode win32 api
592
test_root = unicode(test_root)
594
test_root = test_root.encode(
595
sys.getfilesystemencoding())
596
_rmtree_temp_dir(test_root)
598
note("Failed tests working directories are in '%s'\n", test_root)
599
TestCaseWithMemoryTransport.TEST_ROOT = None
159
def _makeResult(self):
160
result = _MyResult(self.stream, self.descriptions, self.verbosity)
161
if self.stop_on_failure:
162
result = EarlyStoppingTestResultAdapter(result)
836
240
# TODO: perhaps override assertEquals to call this for strings?
840
message = "texts not equal:\n"
841
raise AssertionError(message +
243
raise AssertionError("texts not equal:\n" +
842
244
self._ndiff_strings(a, b))
844
def assertEqualMode(self, mode, mode_test):
845
self.assertEqual(mode, mode_test,
846
'mode mismatch %o != %o' % (mode, mode_test))
848
def assertStartsWith(self, s, prefix):
849
if not s.startswith(prefix):
850
raise AssertionError('string %r does not start with %r' % (s, prefix))
852
def assertEndsWith(self, s, suffix):
853
"""Asserts that s ends with suffix."""
854
if not s.endswith(suffix):
855
raise AssertionError('string %r does not end with %r' % (s, suffix))
857
246
def assertContainsRe(self, haystack, needle_re):
858
247
"""Assert that a contains something matching a regular expression."""
859
248
if not re.search(needle_re, haystack):
860
raise AssertionError('pattern "%r" not found in "%r"'
861
% (needle_re, haystack))
863
def assertNotContainsRe(self, haystack, needle_re):
864
"""Assert that a does not match a regular expression"""
865
if re.search(needle_re, haystack):
866
raise AssertionError('pattern "%s" found in "%s"'
867
% (needle_re, haystack))
869
def assertSubset(self, sublist, superlist):
870
"""Assert that every entry in sublist is present in superlist."""
872
for entry in sublist:
873
if entry not in superlist:
874
missing.append(entry)
876
raise AssertionError("value(s) %r not present in container %r" %
877
(missing, superlist))
879
def assertListRaises(self, excClass, func, *args, **kwargs):
880
"""Fail unless excClass is raised when the iterator from func is used.
882
Many functions can return generators this makes sure
883
to wrap them in a list() call to make sure the whole generator
884
is run, and that the proper exception is raised.
887
list(func(*args, **kwargs))
891
if getattr(excClass,'__name__', None) is not None:
892
excName = excClass.__name__
894
excName = str(excClass)
895
raise self.failureException, "%s not raised" % excName
897
def assertRaises(self, excClass, func, *args, **kwargs):
898
"""Assert that a callable raises a particular exception.
900
:param excClass: As for the except statement, this may be either an
901
exception class, or a tuple of classes.
903
Returns the exception so that you can examine it.
906
func(*args, **kwargs)
910
if getattr(excClass,'__name__', None) is not None:
911
excName = excClass.__name__
914
excName = str(excClass)
915
raise self.failureException, "%s not raised" % excName
917
def assertIs(self, left, right, message=None):
918
if not (left is right):
919
if message is not None:
920
raise AssertionError(message)
922
raise AssertionError("%r is not %r." % (left, right))
924
def assertIsNot(self, left, right, message=None):
926
if message is not None:
927
raise AssertionError(message)
929
raise AssertionError("%r is %r." % (left, right))
931
def assertTransportMode(self, transport, path, mode):
932
"""Fail if a path does not have mode mode.
934
If modes are not supported on this transport, the assertion is ignored.
936
if not transport._can_roundtrip_unix_modebits():
938
path_stat = transport.stat(path)
939
actual_mode = stat.S_IMODE(path_stat.st_mode)
940
self.assertEqual(mode, actual_mode,
941
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
943
def assertIsInstance(self, obj, kls):
944
"""Fail if obj is not an instance of kls"""
945
if not isinstance(obj, kls):
946
self.fail("%r is an instance of %s rather than %s" % (
947
obj, obj.__class__, kls))
949
def expectFailure(self, reason, assertion, *args, **kwargs):
950
"""Invoke a test, expecting it to fail for the given reason.
952
This is for assertions that ought to succeed, but currently fail.
953
(The failure is *expected* but not *wanted*.) Please be very precise
954
about the failure you're expecting. If a new bug is introduced,
955
AssertionError should be raised, not KnownFailure.
957
Frequently, expectFailure should be followed by an opposite assertion.
960
Intended to be used with a callable that raises AssertionError as the
961
'assertion' parameter. args and kwargs are passed to the 'assertion'.
963
Raises KnownFailure if the test fails. Raises AssertionError if the
968
self.expectFailure('Math is broken', self.assertNotEqual, 54,
970
self.assertEqual(42, dynamic_val)
972
This means that a dynamic_val of 54 will cause the test to raise
973
a KnownFailure. Once math is fixed and the expectFailure is removed,
974
only a dynamic_val of 42 will allow the test to pass. Anything other
975
than 54 or 42 will cause an AssertionError.
978
assertion(*args, **kwargs)
979
except AssertionError:
980
raise KnownFailure(reason)
982
self.fail('Unexpected success. Should have failed: %s' % reason)
984
def _capture_warnings(self, a_callable, *args, **kwargs):
985
"""A helper for callDeprecated and applyDeprecated.
987
:param a_callable: A callable to call.
988
:param args: The positional arguments for the callable
989
:param kwargs: The keyword arguments for the callable
990
:return: A tuple (warnings, result). result is the result of calling
991
a_callable(*args, **kwargs).
994
def capture_warnings(msg, cls=None, stacklevel=None):
995
# we've hooked into a deprecation specific callpath,
996
# only deprecations should getting sent via it.
997
self.assertEqual(cls, DeprecationWarning)
998
local_warnings.append(msg)
999
original_warning_method = symbol_versioning.warn
1000
symbol_versioning.set_warning_method(capture_warnings)
1002
result = a_callable(*args, **kwargs)
1004
symbol_versioning.set_warning_method(original_warning_method)
1005
return (local_warnings, result)
1007
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1008
"""Call a deprecated callable without warning the user.
1010
:param deprecation_format: The deprecation format that the callable
1011
should have been deprecated with. This is the same type as the
1012
parameter to deprecated_method/deprecated_function. If the
1013
callable is not deprecated with this format, an assertion error
1015
:param a_callable: A callable to call. This may be a bound method or
1016
a regular function. It will be called with *args and **kwargs.
1017
:param args: The positional arguments for the callable
1018
:param kwargs: The keyword arguments for the callable
1019
:return: The result of a_callable(*args, **kwargs)
1021
call_warnings, result = self._capture_warnings(a_callable,
1023
expected_first_warning = symbol_versioning.deprecation_string(
1024
a_callable, deprecation_format)
1025
if len(call_warnings) == 0:
1026
self.fail("No deprecation warning generated by call to %s" %
1028
self.assertEqual(expected_first_warning, call_warnings[0])
1031
def callDeprecated(self, expected, callable, *args, **kwargs):
1032
"""Assert that a callable is deprecated in a particular way.
1034
This is a very precise test for unusual requirements. The
1035
applyDeprecated helper function is probably more suited for most tests
1036
as it allows you to simply specify the deprecation format being used
1037
and will ensure that that is issued for the function being called.
1039
:param expected: a list of the deprecation warnings expected, in order
1040
:param callable: The callable to call
1041
:param args: The positional arguments for the callable
1042
:param kwargs: The keyword arguments for the callable
1044
call_warnings, result = self._capture_warnings(callable,
1046
self.assertEqual(expected, call_warnings)
249
raise AssertionError('pattern "%s" not found in "%s"'
250
% (needle_re, haystack))
1049
252
def _startLogFile(self):
1050
253
"""Send bzr and test log messages to a temporary file.
1310
400
This sends the stdout/stderr results into the test's log,
1311
401
where it may be useful for debugging. See also run_captured.
1313
:param stdin: A string to be used as stdin for the command.
1314
:param retcode: The status code the command should return
1315
:param working_dir: The directory to run the command in
1317
403
retcode = kwargs.pop('retcode', 0)
1318
encoding = kwargs.pop('encoding', None)
1319
stdin = kwargs.pop('stdin', None)
1320
working_dir = kwargs.pop('working_dir', None)
1321
error_regexes = kwargs.pop('error_regexes', [])
1323
out, err = self.run_bzr_captured(args, retcode=retcode,
1324
encoding=encoding, stdin=stdin, working_dir=working_dir)
1326
for regex in error_regexes:
1327
self.assertContainsRe(err, regex)
1331
def run_bzr_decode(self, *args, **kwargs):
1332
if 'encoding' in kwargs:
1333
encoding = kwargs['encoding']
1335
encoding = bzrlib.user_encoding
1336
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1338
def run_bzr_error(self, error_regexes, *args, **kwargs):
1339
"""Run bzr, and check that stderr contains the supplied regexes
1341
:param error_regexes: Sequence of regular expressions which
1342
must each be found in the error output. The relative ordering
1344
:param args: command-line arguments for bzr
1345
:param kwargs: Keyword arguments which are interpreted by run_bzr
1346
This function changes the default value of retcode to be 3,
1347
since in most cases this is run when you expect bzr to fail.
1348
:return: (out, err) The actual output of running the command (in case you
1349
want to do more inspection)
1352
# Make sure that commit is failing because there is nothing to do
1353
self.run_bzr_error(['no changes to commit'],
1354
'commit', '-m', 'my commit comment')
1355
# Make sure --strict is handling an unknown file, rather than
1356
# giving us the 'nothing to do' error
1357
self.build_tree(['unknown'])
1358
self.run_bzr_error(['Commit refused because there are unknown files'],
1359
'commit', '--strict', '-m', 'my commit comment')
1361
kwargs.setdefault('retcode', 3)
1362
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1365
def run_bzr_subprocess(self, *args, **kwargs):
1366
"""Run bzr in a subprocess for testing.
1368
This starts a new Python interpreter and runs bzr in there.
1369
This should only be used for tests that have a justifiable need for
1370
this isolation: e.g. they are testing startup time, or signal
1371
handling, or early startup code, etc. Subprocess code can't be
1372
profiled or debugged so easily.
1374
:param retcode: The status code that is expected. Defaults to 0. If
1375
None is supplied, the status code is not checked.
1376
:param env_changes: A dictionary which lists changes to environment
1377
variables. A value of None will unset the env variable.
1378
The values must be strings. The change will only occur in the
1379
child, so you don't need to fix the environment after running.
1380
:param universal_newlines: Convert CRLF => LF
1381
:param allow_plugins: By default the subprocess is run with
1382
--no-plugins to ensure test reproducibility. Also, it is possible
1383
for system-wide plugins to create unexpected output on stderr,
1384
which can cause unnecessary test failures.
1386
env_changes = kwargs.get('env_changes', {})
1387
working_dir = kwargs.get('working_dir', None)
1388
allow_plugins = kwargs.get('allow_plugins', False)
1389
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1390
working_dir=working_dir,
1391
allow_plugins=allow_plugins)
1392
# We distinguish between retcode=None and retcode not passed.
1393
supplied_retcode = kwargs.get('retcode', 0)
1394
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1395
universal_newlines=kwargs.get('universal_newlines', False),
1398
def start_bzr_subprocess(self, process_args, env_changes=None,
1399
skip_if_plan_to_signal=False,
1401
allow_plugins=False):
1402
"""Start bzr in a subprocess for testing.
1404
This starts a new Python interpreter and runs bzr in there.
1405
This should only be used for tests that have a justifiable need for
1406
this isolation: e.g. they are testing startup time, or signal
1407
handling, or early startup code, etc. Subprocess code can't be
1408
profiled or debugged so easily.
1410
:param process_args: a list of arguments to pass to the bzr executable,
1411
for example `['--version']`.
1412
:param env_changes: A dictionary which lists changes to environment
1413
variables. A value of None will unset the env variable.
1414
The values must be strings. The change will only occur in the
1415
child, so you don't need to fix the environment after running.
1416
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1418
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1420
:returns: Popen object for the started process.
1422
if skip_if_plan_to_signal:
1423
if not getattr(os, 'kill', None):
1424
raise TestSkipped("os.kill not available.")
1426
if env_changes is None:
1430
def cleanup_environment():
1431
for env_var, value in env_changes.iteritems():
1432
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1434
def restore_environment():
1435
for env_var, value in old_env.iteritems():
1436
osutils.set_or_unset_env(env_var, value)
1438
bzr_path = self.get_bzr_path()
1441
if working_dir is not None:
1442
cwd = osutils.getcwd()
1443
os.chdir(working_dir)
1446
# win32 subprocess doesn't support preexec_fn
1447
# so we will avoid using it on all platforms, just to
1448
# make sure the code path is used, and we don't break on win32
1449
cleanup_environment()
1450
command = [sys.executable, bzr_path]
1451
if not allow_plugins:
1452
command.append('--no-plugins')
1453
command.extend(process_args)
1454
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1456
restore_environment()
1462
def _popen(self, *args, **kwargs):
1463
"""Place a call to Popen.
1465
Allows tests to override this method to intercept the calls made to
1466
Popen for introspection.
1468
return Popen(*args, **kwargs)
1470
def get_bzr_path(self):
1471
"""Return the path of the 'bzr' executable for this test suite."""
1472
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1473
if not os.path.isfile(bzr_path):
1474
# We are probably installed. Assume sys.argv is the right file
1475
bzr_path = sys.argv[0]
1478
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1479
universal_newlines=False, process_args=None):
1480
"""Finish the execution of process.
1482
:param process: the Popen object returned from start_bzr_subprocess.
1483
:param retcode: The status code that is expected. Defaults to 0. If
1484
None is supplied, the status code is not checked.
1485
:param send_signal: an optional signal to send to the process.
1486
:param universal_newlines: Convert CRLF => LF
1487
:returns: (stdout, stderr)
1489
if send_signal is not None:
1490
os.kill(process.pid, send_signal)
1491
out, err = process.communicate()
1493
if universal_newlines:
1494
out = out.replace('\r\n', '\n')
1495
err = err.replace('\r\n', '\n')
1497
if retcode is not None and retcode != process.returncode:
1498
if process_args is None:
1499
process_args = "(unknown args)"
1500
mutter('Output of bzr %s:\n%s', process_args, out)
1501
mutter('Error for bzr %s:\n%s', process_args, err)
1502
self.fail('Command bzr %s failed with retcode %s != %s'
1503
% (process_args, retcode, process.returncode))
404
return self.run_bzr_captured(args, retcode)
1506
406
def check_inventory_shape(self, inv, shape):
1507
407
"""Compare an inventory to a list of expected names.
1555
455
sys.stderr = real_stderr
1556
456
sys.stdin = real_stdin
1558
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1559
def merge(self, branch_from, wt_to):
1560
"""A helper for tests to do a ui-less merge.
1562
This should move to the main library when someone has time to integrate
1565
# minimal ui-less merge.
1566
wt_to.branch.fetch(branch_from)
1567
base_rev = common_ancestor(branch_from.last_revision(),
1568
wt_to.branch.last_revision(),
1569
wt_to.branch.repository)
1570
merge_inner(wt_to.branch, branch_from.basis_tree(),
1571
wt_to.branch.repository.revision_tree(base_rev),
1573
wt_to.add_parent_tree_id(branch_from.last_revision())
1575
def reduceLockdirTimeout(self):
1576
"""Reduce the default lock timeout for the duration of the test, so that
1577
if LockContention occurs during a test, it does so quickly.
1579
Tests that expect to provoke LockContention errors should call this.
1581
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1583
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1584
self.addCleanup(resetTimeout)
1585
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1587
459
BzrTestBase = TestCase
1590
class TestCaseWithMemoryTransport(TestCase):
1591
"""Common test class for tests that do not need disk resources.
1593
Tests that need disk resources should derive from TestCaseWithTransport.
1595
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1597
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1598
a directory which does not exist. This serves to help ensure test isolation
1599
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1600
must exist. However, TestCaseWithMemoryTransport does not offer local
1601
file defaults for the transport in tests, nor does it obey the command line
1602
override, so tests that accidentally write to the common directory should
462
class TestCaseInTempDir(TestCase):
463
"""Derived class that runs a test within a temporary directory.
465
This is useful for tests that need to create a branch, etc.
467
The directory is created in a slightly complex way: for each
468
Python invocation, a new temporary top-level directory is created.
469
All test cases create their own directory within that. If the
470
tests complete successfully, the directory is removed.
472
InTempDir is an old alias for FunctionalTestCase.
1606
475
TEST_ROOT = None
1607
476
_TEST_NAME = 'test'
1610
def __init__(self, methodName='runTest'):
1611
# allow test parameterisation after test construction and before test
1612
# execution. Variables that the parameteriser sets need to be
1613
# ones that are not set by setUp, or setUp will trash them.
1614
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1615
self.vfs_transport_factory = default_transport
1616
self.transport_server = None
1617
self.transport_readonly_server = None
1618
self.__vfs_server = None
1620
def get_transport(self):
1621
"""Return a writeable transport for the test scratch space"""
1622
t = get_transport(self.get_url())
1623
self.assertFalse(t.is_readonly())
1626
def get_readonly_transport(self):
1627
"""Return a readonly transport for the test scratch space
1629
This can be used to test that operations which should only need
1630
readonly access in fact do not try to write.
1632
t = get_transport(self.get_readonly_url())
1633
self.assertTrue(t.is_readonly())
1636
def create_transport_readonly_server(self):
1637
"""Create a transport server from class defined at init.
1639
This is mostly a hook for daughter classes.
1641
return self.transport_readonly_server()
1643
def get_readonly_server(self):
1644
"""Get the server instance for the readonly transport
1646
This is useful for some tests with specific servers to do diagnostics.
1648
if self.__readonly_server is None:
1649
if self.transport_readonly_server is None:
1650
# readonly decorator requested
1651
# bring up the server
1652
self.__readonly_server = ReadonlyServer()
1653
self.__readonly_server.setUp(self.get_vfs_only_server())
1655
self.__readonly_server = self.create_transport_readonly_server()
1656
self.__readonly_server.setUp(self.get_vfs_only_server())
1657
self.addCleanup(self.__readonly_server.tearDown)
1658
return self.__readonly_server
1660
def get_readonly_url(self, relpath=None):
1661
"""Get a URL for the readonly transport.
1663
This will either be backed by '.' or a decorator to the transport
1664
used by self.get_url()
1665
relpath provides for clients to get a path relative to the base url.
1666
These should only be downwards relative, not upwards.
1668
base = self.get_readonly_server().get_url()
1669
if relpath is not None:
1670
if not base.endswith('/'):
1672
base = base + relpath
1675
def get_vfs_only_server(self):
1676
"""Get the vfs only read/write server instance.
1678
This is useful for some tests with specific servers that need
1681
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1682
is no means to override it.
1684
if self.__vfs_server is None:
1685
self.__vfs_server = MemoryServer()
1686
self.__vfs_server.setUp()
1687
self.addCleanup(self.__vfs_server.tearDown)
1688
return self.__vfs_server
1690
def get_server(self):
1691
"""Get the read/write server instance.
1693
This is useful for some tests with specific servers that need
1696
This is built from the self.transport_server factory. If that is None,
1697
then the self.get_vfs_server is returned.
1699
if self.__server is None:
1700
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1701
return self.get_vfs_only_server()
1703
# bring up a decorated means of access to the vfs only server.
1704
self.__server = self.transport_server()
1706
self.__server.setUp(self.get_vfs_only_server())
1707
except TypeError, e:
1708
# This should never happen; the try:Except here is to assist
1709
# developers having to update code rather than seeing an
1710
# uninformative TypeError.
1711
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1712
self.addCleanup(self.__server.tearDown)
1713
return self.__server
1715
def _adjust_url(self, base, relpath):
1716
"""Get a URL (or maybe a path) for the readwrite transport.
1718
This will either be backed by '.' or to an equivalent non-file based
1720
relpath provides for clients to get a path relative to the base url.
1721
These should only be downwards relative, not upwards.
1723
if relpath is not None and relpath != '.':
1724
if not base.endswith('/'):
1726
# XXX: Really base should be a url; we did after all call
1727
# get_url()! But sometimes it's just a path (from
1728
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1729
# to a non-escaped local path.
1730
if base.startswith('./') or base.startswith('/'):
1733
base += urlutils.escape(relpath)
1736
def get_url(self, relpath=None):
1737
"""Get a URL (or maybe a path) for the readwrite transport.
1739
This will either be backed by '.' or to an equivalent non-file based
1741
relpath provides for clients to get a path relative to the base url.
1742
These should only be downwards relative, not upwards.
1744
base = self.get_server().get_url()
1745
return self._adjust_url(base, relpath)
1747
def get_vfs_only_url(self, relpath=None):
1748
"""Get a URL (or maybe a path for the plain old vfs transport.
1750
This will never be a smart protocol. It always has all the
1751
capabilities of the local filesystem, but it might actually be a
1752
MemoryTransport or some other similar virtual filesystem.
1754
This is the backing transport (if any) of the server returned by
1755
get_url and get_readonly_url.
1757
:param relpath: provides for clients to get a path relative to the base
1758
url. These should only be downwards relative, not upwards.
1760
base = self.get_vfs_only_server().get_url()
1761
return self._adjust_url(base, relpath)
477
OVERRIDE_PYTHON = 'python'
479
def check_file_contents(self, filename, expect):
480
self.log("check contents of file %s" % filename)
481
contents = file(filename, 'r').read()
482
if contents != expect:
483
self.log("expected: %r" % expect)
484
self.log("actually: %r" % contents)
485
self.fail("contents of %s not as expected" % filename)
1763
487
def _make_test_root(self):
1764
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
488
if TestCaseInTempDir.TEST_ROOT is not None:
1777
501
# successfully created
1778
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
502
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
1780
504
# make a fake bzr directory there to prevent any tests propagating
1781
505
# up onto the source directory's real branch
1782
bzrdir.BzrDir.create_standalone_workingtree(
1783
TestCaseWithMemoryTransport.TEST_ROOT)
1785
def makeAndChdirToTestDir(self):
1786
"""Create a temporary directories for this one test.
1788
This must set self.test_home_dir and self.test_dir and chdir to
1791
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1793
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1794
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1795
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1797
def make_branch(self, relpath, format=None):
1798
"""Create a branch on the transport at relpath."""
1799
repo = self.make_repository(relpath, format=format)
1800
return repo.bzrdir.create_branch()
1802
def make_bzrdir(self, relpath, format=None):
1804
# might be a relative or absolute path
1805
maybe_a_url = self.get_url(relpath)
1806
segments = maybe_a_url.rsplit('/', 1)
1807
t = get_transport(maybe_a_url)
1808
if len(segments) > 1 and segments[-1] not in ('', '.'):
1812
if isinstance(format, basestring):
1813
format = bzrdir.format_registry.make_bzrdir(format)
1814
return format.initialize_on_transport(t)
1815
except errors.UninitializableFormat:
1816
raise TestSkipped("Format %s is not initializable." % format)
1818
def make_repository(self, relpath, shared=False, format=None):
1819
"""Create a repository on our default transport at relpath.
1821
Note that relpath must be a relative path, not a full url.
1823
# FIXME: If you create a remoterepository this returns the underlying
1824
# real format, which is incorrect. Actually we should make sure that
1825
# RemoteBzrDir returns a RemoteRepository.
1826
# maybe mbp 20070410
1827
made_control = self.make_bzrdir(relpath, format=format)
1828
return made_control.create_repository(shared=shared)
1830
def make_branch_and_memory_tree(self, relpath, format=None):
1831
"""Create a branch on the default transport and a MemoryTree for it."""
1832
b = self.make_branch(relpath, format=format)
1833
return memorytree.MemoryTree.create_on_branch(b)
1835
def overrideEnvironmentForTesting(self):
1836
os.environ['HOME'] = self.test_home_dir
1837
os.environ['BZR_HOME'] = self.test_home_dir
506
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
1839
508
def setUp(self):
1840
super(TestCaseWithMemoryTransport, self).setUp()
509
super(TestCaseInTempDir, self).setUp()
1841
510
self._make_test_root()
1842
511
_currentdir = os.getcwdu()
512
short_id = self.id().replace('bzrlib.tests.', '') \
513
.replace('__main__.', '')
514
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
515
os.mkdir(self.test_dir)
516
os.chdir(self.test_dir)
517
os.environ['HOME'] = self.test_dir
1843
518
def _leaveDirectory():
1844
519
os.chdir(_currentdir)
1845
520
self.addCleanup(_leaveDirectory)
1846
self.makeAndChdirToTestDir()
1847
self.overrideEnvironmentForTesting()
1848
self.__readonly_server = None
1849
self.__server = None
1850
self.reduceLockdirTimeout()
1853
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1854
"""Derived class that runs a test within a temporary directory.
1856
This is useful for tests that need to create a branch, etc.
1858
The directory is created in a slightly complex way: for each
1859
Python invocation, a new temporary top-level directory is created.
1860
All test cases create their own directory within that. If the
1861
tests complete successfully, the directory is removed.
1863
InTempDir is an old alias for FunctionalTestCase.
1866
OVERRIDE_PYTHON = 'python'
1867
use_numbered_dirs = False
1869
def check_file_contents(self, filename, expect):
1870
self.log("check contents of file %s" % filename)
1871
contents = file(filename, 'r').read()
1872
if contents != expect:
1873
self.log("expected: %r" % expect)
1874
self.log("actually: %r" % contents)
1875
self.fail("contents of %s not as expected" % filename)
1877
def makeAndChdirToTestDir(self):
1878
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1880
For TestCaseInTempDir we create a temporary directory based on the test
1881
name and then create two subdirs - test and home under it.
1883
if self.use_numbered_dirs: # strongly recommended on Windows
1884
# due the path length limitation (260 ch.)
1885
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1886
int(self.number/1000),
1888
os.makedirs(candidate_dir)
1889
self.test_home_dir = candidate_dir + '/home'
1890
os.mkdir(self.test_home_dir)
1891
self.test_dir = candidate_dir + '/work'
1892
os.mkdir(self.test_dir)
1893
os.chdir(self.test_dir)
1894
# put name of test inside
1895
f = file(candidate_dir + '/name', 'w')
1900
# shorten the name, to avoid test failures due to path length
1901
short_id = self.id().replace('bzrlib.tests.', '') \
1902
.replace('__main__.', '')[-100:]
1903
# it's possible the same test class is run several times for
1904
# parameterized tests, so make sure the names don't collide.
1908
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1910
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1911
if os.path.exists(candidate_dir):
1915
os.mkdir(candidate_dir)
1916
self.test_home_dir = candidate_dir + '/home'
1917
os.mkdir(self.test_home_dir)
1918
self.test_dir = candidate_dir + '/work'
1919
os.mkdir(self.test_dir)
1920
os.chdir(self.test_dir)
1923
def build_tree(self, shape, line_endings='binary', transport=None):
522
def build_tree(self, shape, line_endings='native'):
1924
523
"""Build a test tree according to a pattern.
1926
525
shape is a sequence of file specifications. If the final
1927
526
character is '/', a directory is created.
1929
This assumes that all the elements in the tree being built are new.
1931
528
This doesn't add anything to a branch.
1932
529
:param line_endings: Either 'binary' or 'native'
1933
530
in binary mode, exact contents are written
1934
531
in native mode, the line endings match the
1935
532
default platform endings.
1937
:param transport: A transport to write to, for building trees on
1938
VFS's. If the transport is readonly or None,
1939
"." is opened automatically.
1941
# It's OK to just create them using forward slashes on windows.
1942
if transport is None or transport.is_readonly():
1943
transport = get_transport(".")
534
# XXX: It's OK to just create them using forward slashes on windows?
1944
535
for name in shape:
1945
536
self.assert_(isinstance(name, basestring))
1946
537
if name[-1] == '/':
1947
transport.mkdir(urlutils.escape(name[:-1]))
1949
540
if line_endings == 'binary':
1951
542
elif line_endings == 'native':
1954
raise errors.BzrError(
1955
'Invalid line ending request %r' % line_endings)
1956
content = "contents of %s%s" % (name.encode('utf-8'), end)
1957
transport.put_bytes_non_atomic(urlutils.escape(name), content)
545
raise BzrError('Invalid line ending request %r' % (line_endings,))
546
print >>f, "contents of", name
1959
549
def build_tree_contents(self, shape):
1960
550
build_tree_contents(shape)
552
def failUnlessExists(self, path):
553
"""Fail unless path, which may be abs or relative, exists."""
554
self.failUnless(osutils.lexists(path))
1962
556
def assertFileEqual(self, content, path):
1963
557
"""Fail if path does not contain 'content'."""
1964
self.failUnlessExists(path)
1965
f = file(path, 'rb')
1970
self.assertEqualDiff(content, s)
1972
def failUnlessExists(self, path):
1973
"""Fail unless path or paths, which may be abs or relative, exist."""
1974
if not isinstance(path, basestring):
1976
self.failUnlessExists(p)
1978
self.failUnless(osutils.lexists(path),path+" does not exist")
1980
def failIfExists(self, path):
1981
"""Fail if path or paths, which may be abs or relative, exist."""
1982
if not isinstance(path, basestring):
1984
self.failIfExists(p)
1986
self.failIf(osutils.lexists(path),path+" exists")
1988
def assertInWorkingTree(self,path,root_path='.',tree=None):
1989
"""Assert whether path or paths are in the WorkingTree"""
1991
tree = workingtree.WorkingTree.open(root_path)
1992
if not isinstance(path, basestring):
1994
self.assertInWorkingTree(p,tree=tree)
1996
self.assertIsNot(tree.path2id(path), None,
1997
path+' not in working tree.')
1999
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2000
"""Assert whether path or paths are not in the WorkingTree"""
2002
tree = workingtree.WorkingTree.open(root_path)
2003
if not isinstance(path, basestring):
2005
self.assertNotInWorkingTree(p,tree=tree)
2007
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2010
class TestCaseWithTransport(TestCaseInTempDir):
2011
"""A test case that provides get_url and get_readonly_url facilities.
2013
These back onto two transport servers, one for readonly access and one for
2016
If no explicit class is provided for readonly access, a
2017
ReadonlyTransportDecorator is used instead which allows the use of non disk
2018
based read write transports.
2020
If an explicit class is provided for readonly access, that server and the
2021
readwrite one must both define get_url() as resolving to os.getcwd().
2024
def get_vfs_only_server(self):
2025
"""See TestCaseWithMemoryTransport.
2027
This is useful for some tests with specific servers that need
2030
if self.__vfs_server is None:
2031
self.__vfs_server = self.vfs_transport_factory()
2032
self.__vfs_server.setUp()
2033
self.addCleanup(self.__vfs_server.tearDown)
2034
return self.__vfs_server
2036
def make_branch_and_tree(self, relpath, format=None):
2037
"""Create a branch on the transport and a tree locally.
2039
If the transport is not a LocalTransport, the Tree can't be created on
2040
the transport. In that case if the vfs_transport_factory is
2041
LocalURLServer the working tree is created in the local
2042
directory backing the transport, and the returned tree's branch and
2043
repository will also be accessed locally. Otherwise a lightweight
2044
checkout is created and returned.
2046
:param format: The BzrDirFormat.
2047
:returns: the WorkingTree.
2049
# TODO: always use the local disk path for the working tree,
2050
# this obviously requires a format that supports branch references
2051
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2053
b = self.make_branch(relpath, format=format)
2055
return b.bzrdir.create_workingtree()
2056
except errors.NotLocalUrl:
2057
# We can only make working trees locally at the moment. If the
2058
# transport can't support them, then we keep the non-disk-backed
2059
# branch and create a local checkout.
2060
if self.vfs_transport_factory is LocalURLServer:
2061
# the branch is colocated on disk, we cannot create a checkout.
2062
# hopefully callers will expect this.
2063
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2064
return local_controldir.create_workingtree()
2066
return b.create_checkout(relpath, lightweight=True)
2068
def assertIsDirectory(self, relpath, transport):
2069
"""Assert that relpath within transport is a directory.
2071
This may not be possible on all transports; in that case it propagates
2072
a TransportNotPossible.
2075
mode = transport.stat(relpath).st_mode
2076
except errors.NoSuchFile:
2077
self.fail("path %s is not a directory; no such file"
2079
if not stat.S_ISDIR(mode):
2080
self.fail("path %s is not a directory; has mode %#o"
2083
def assertTreesEqual(self, left, right):
2084
"""Check that left and right have the same content and properties."""
2085
# we use a tree delta to check for equality of the content, and we
2086
# manually check for equality of other things such as the parents list.
2087
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2088
differences = left.changes_from(right)
2089
self.assertFalse(differences.has_changed(),
2090
"Trees %r and %r are different: %r" % (left, right, differences))
2093
super(TestCaseWithTransport, self).setUp()
2094
self.__vfs_server = None
2097
class ChrootedTestCase(TestCaseWithTransport):
2098
"""A support class that provides readonly urls outside the local namespace.
2100
This is done by checking if self.transport_server is a MemoryServer. if it
2101
is then we are chrooted already, if it is not then an HttpServer is used
2104
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2105
be used without needed to redo it when a different
2106
subclass is in use ?
2110
super(ChrootedTestCase, self).setUp()
2111
if not self.vfs_transport_factory == MemoryServer:
2112
self.transport_readonly_server = HttpServer
2115
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2116
random_order=False):
2117
"""Create a test suite by filtering another one.
2119
:param suite: the source suite
2120
:param pattern: pattern that names must match
2121
:param exclude_pattern: pattern that names must not match, if any
2122
:param random_order: if True, tests in the new suite will be put in
2124
:returns: the newly created suite
2126
return sort_suite_by_re(suite, pattern, exclude_pattern,
2127
random_order, False)
2130
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2131
random_order=False, append_rest=True):
2132
"""Create a test suite by sorting another one.
2134
:param suite: the source suite
2135
:param pattern: pattern that names must match in order to go
2136
first in the new suite
2137
:param exclude_pattern: pattern that names must not match, if any
2138
:param random_order: if True, tests in the new suite will be put in
2140
:param append_rest: if False, pattern is a strict filter and not
2141
just an ordering directive
2142
:returns: the newly created suite
558
self.failUnless(osutils.lexists(path))
559
self.assertEqualDiff(content, open(path, 'r').read())
562
class MetaTestLog(TestCase):
563
def test_logging(self):
564
"""Test logs are captured when a test fails."""
565
self.log('a test message')
566
self._log_file.flush()
567
self.assertContainsRe(self._get_log(), 'a test message\n')
570
def filter_suite_by_re(suite, pattern):
571
result = TestUtil.TestSuite()
2146
572
filter_re = re.compile(pattern)
2147
if exclude_pattern is not None:
2148
exclude_re = re.compile(exclude_pattern)
2149
573
for test in iter_suite_tests(suite):
2151
if exclude_pattern is None or not exclude_re.search(test_id):
2152
if filter_re.search(test_id):
2157
random.shuffle(first)
2158
random.shuffle(second)
2159
return TestUtil.TestSuite(first + second)
574
if filter_re.search(test.id()):
2162
579
def run_suite(suite, name='test', verbose=False, pattern=".*",
2163
stop_on_failure=False, keep_output=False,
2164
transport=None, lsprof_timed=None, bench_history=None,
2165
matching_tests_first=None,
2169
exclude_pattern=None,
2171
use_numbered_dirs = bool(numbered_dirs)
2173
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2174
if numbered_dirs is not None:
2175
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
580
stop_on_failure=False, keep_output=False):
581
TestCaseInTempDir._TEST_NAME = name
2180
586
runner = TextTestRunner(stream=sys.stdout,
2182
verbosity=verbosity,
2183
keep_output=keep_output,
2184
bench_history=bench_history,
2185
use_numbered_dirs=use_numbered_dirs,
2186
list_only=list_only,
2188
589
runner.stop_on_failure=stop_on_failure
2189
# Initialise the random number generator and display the seed used.
2190
# We convert the seed to a long to make it reuseable across invocations.
2191
random_order = False
2192
if random_seed is not None:
2194
if random_seed == "now":
2195
random_seed = long(time.time())
2197
# Convert the seed to a long if we can
2199
random_seed = long(random_seed)
2202
runner.stream.writeln("Randomizing test order using seed %s\n" %
2204
random.seed(random_seed)
2205
# Customise the list of tests if requested
2206
if pattern != '.*' or exclude_pattern is not None or random_order:
2207
if matching_tests_first:
2208
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2211
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
591
suite = filter_suite_by_re(suite, pattern)
2213
592
result = runner.run(suite)
593
# This is still a little bogus,
594
# but only a little. Folk not using our testrunner will
595
# have to delete their temp directories themselves.
596
if result.wasSuccessful() or not keep_output:
597
if TestCaseInTempDir.TEST_ROOT is not None:
598
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
600
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
2214
601
return result.wasSuccessful()
2217
604
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2220
test_suite_factory=None,
2223
matching_tests_first=None,
2227
exclude_pattern=None):
2228
606
"""Run the whole test suite under the enhanced runner"""
2229
# XXX: Very ugly way to do this...
2230
# Disable warning about old formats because we don't want it to disturb
2231
# any blackbox tests.
2232
from bzrlib import repository
2233
repository._deprecation_warning_done = True
2235
global default_transport
2236
if transport is None:
2237
transport = default_transport
2238
old_transport = default_transport
2239
default_transport = transport
2241
if test_suite_factory is None:
2242
suite = test_suite()
2244
suite = test_suite_factory()
2245
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2246
stop_on_failure=stop_on_failure, keep_output=keep_output,
2247
transport=transport,
2248
lsprof_timed=lsprof_timed,
2249
bench_history=bench_history,
2250
matching_tests_first=matching_tests_first,
2251
numbered_dirs=numbered_dirs,
2252
list_only=list_only,
2253
random_seed=random_seed,
2254
exclude_pattern=exclude_pattern)
2256
default_transport = old_transport
607
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
608
stop_on_failure=stop_on_failure, keep_output=keep_output)
2259
611
def test_suite():
2260
"""Build and return TestSuite for the whole of bzrlib.
2262
This function can be replaced if you need to change the default test
2263
suite on a global basis, but it is not encouraged.
612
"""Build and return TestSuite for the whole program."""
613
from doctest import DocTestSuite
615
global MODULES_TO_DOCTEST
617
# FIXME: If these fail to load, e.g. because of a syntax error, the
618
# exception is hidden by unittest. Sucks. Should either fix that or
619
# perhaps import them and pass them to unittest as modules.
621
['bzrlib.tests.MetaTestLog',
622
'bzrlib.tests.test_api',
623
'bzrlib.tests.test_gpg',
624
'bzrlib.tests.test_identitymap',
625
'bzrlib.tests.test_inv',
2266
626
'bzrlib.tests.test_ancestry',
2267
'bzrlib.tests.test_annotate',
2268
'bzrlib.tests.test_api',
2269
'bzrlib.tests.test_atomicfile',
2270
'bzrlib.tests.test_bad_files',
2271
'bzrlib.tests.test_branch',
2272
'bzrlib.tests.test_branchbuilder',
2273
'bzrlib.tests.test_bugtracker',
2274
'bzrlib.tests.test_bundle',
2275
'bzrlib.tests.test_bzrdir',
2276
'bzrlib.tests.test_cache_utf8',
2277
'bzrlib.tests.test_commands',
2278
627
'bzrlib.tests.test_commit',
628
'bzrlib.tests.test_command',
2279
629
'bzrlib.tests.test_commit_merge',
2280
630
'bzrlib.tests.test_config',
2281
'bzrlib.tests.test_conflicts',
2282
'bzrlib.tests.test_counted_lock',
2283
'bzrlib.tests.test_decorators',
2284
'bzrlib.tests.test_delta',
2285
'bzrlib.tests.test_diff',
2286
'bzrlib.tests.test_dirstate',
2287
'bzrlib.tests.test_errors',
2288
'bzrlib.tests.test_escaped_store',
2289
'bzrlib.tests.test_extract',
2290
'bzrlib.tests.test_fetch',
2291
'bzrlib.tests.test_ftp_transport',
2292
'bzrlib.tests.test_generate_docs',
2293
'bzrlib.tests.test_generate_ids',
2294
'bzrlib.tests.test_globbing',
2295
'bzrlib.tests.test_gpg',
2296
'bzrlib.tests.test_graph',
631
'bzrlib.tests.test_merge3',
632
'bzrlib.tests.test_merge',
2297
633
'bzrlib.tests.test_hashcache',
2298
'bzrlib.tests.test_help',
2299
'bzrlib.tests.test_http',
2300
'bzrlib.tests.test_http_response',
2301
'bzrlib.tests.test_https_ca_bundle',
2302
'bzrlib.tests.test_identitymap',
2303
'bzrlib.tests.test_ignores',
2304
'bzrlib.tests.test_inv',
2305
'bzrlib.tests.test_knit',
2306
'bzrlib.tests.test_lazy_import',
2307
'bzrlib.tests.test_lazy_regex',
2308
'bzrlib.tests.test_lockdir',
2309
'bzrlib.tests.test_lockable_files',
634
'bzrlib.tests.test_status',
2310
635
'bzrlib.tests.test_log',
2311
'bzrlib.tests.test_memorytree',
2312
'bzrlib.tests.test_merge',
2313
'bzrlib.tests.test_merge3',
636
'bzrlib.tests.test_revisionnamespaces',
637
'bzrlib.tests.test_branch',
638
'bzrlib.tests.test_revision',
639
'bzrlib.tests.test_revision_info',
2314
640
'bzrlib.tests.test_merge_core',
2315
'bzrlib.tests.test_merge_directive',
2316
'bzrlib.tests.test_missing',
2317
'bzrlib.tests.test_msgeditor',
2318
'bzrlib.tests.test_multiparent',
2319
'bzrlib.tests.test_nonascii',
2320
'bzrlib.tests.test_options',
2321
'bzrlib.tests.test_osutils',
2322
'bzrlib.tests.test_osutils_encodings',
2323
'bzrlib.tests.test_patch',
2324
'bzrlib.tests.test_patches',
2325
'bzrlib.tests.test_permissions',
2326
'bzrlib.tests.test_plugins',
2327
'bzrlib.tests.test_progress',
2328
'bzrlib.tests.test_reconcile',
2329
'bzrlib.tests.test_registry',
2330
'bzrlib.tests.test_remote',
2331
'bzrlib.tests.test_repository',
2332
'bzrlib.tests.test_revert',
2333
'bzrlib.tests.test_revision',
2334
'bzrlib.tests.test_revisionnamespaces',
2335
'bzrlib.tests.test_revisiontree',
2336
'bzrlib.tests.test_rio',
2337
'bzrlib.tests.test_sampler',
2338
'bzrlib.tests.test_selftest',
2339
'bzrlib.tests.test_setup',
2340
'bzrlib.tests.test_sftp_transport',
2341
'bzrlib.tests.test_smart',
2342
641
'bzrlib.tests.test_smart_add',
2343
'bzrlib.tests.test_smart_transport',
2344
'bzrlib.tests.test_source',
2345
'bzrlib.tests.test_ssh_transport',
2346
'bzrlib.tests.test_status',
642
'bzrlib.tests.test_bad_files',
643
'bzrlib.tests.test_diff',
644
'bzrlib.tests.test_parent',
645
'bzrlib.tests.test_xml',
646
'bzrlib.tests.test_weave',
647
'bzrlib.tests.test_fetch',
648
'bzrlib.tests.test_whitebox',
2347
649
'bzrlib.tests.test_store',
2348
'bzrlib.tests.test_strace',
2349
'bzrlib.tests.test_subsume',
2350
'bzrlib.tests.test_symbol_versioning',
2351
'bzrlib.tests.test_tag',
2352
'bzrlib.tests.test_testament',
2353
'bzrlib.tests.test_textfile',
2354
'bzrlib.tests.test_textmerge',
2355
'bzrlib.tests.test_timestamp',
2356
'bzrlib.tests.test_trace',
650
'bzrlib.tests.test_sampler',
2357
651
'bzrlib.tests.test_transactions',
2358
'bzrlib.tests.test_transform',
2359
652
'bzrlib.tests.test_transport',
2360
'bzrlib.tests.test_tree',
2361
'bzrlib.tests.test_treebuilder',
653
'bzrlib.tests.test_sftp',
654
'bzrlib.tests.test_graph',
655
'bzrlib.tests.test_workingtree',
656
'bzrlib.tests.test_upgrade',
657
'bzrlib.tests.test_uncommit',
658
'bzrlib.tests.test_conflicts',
659
'bzrlib.tests.test_testament',
660
'bzrlib.tests.test_annotate',
661
'bzrlib.tests.test_revprops',
662
'bzrlib.tests.test_options',
663
'bzrlib.tests.test_http',
664
'bzrlib.tests.test_nonascii',
665
'bzrlib.tests.test_reweave',
2362
666
'bzrlib.tests.test_tsort',
2363
'bzrlib.tests.test_tuned_gzip',
2364
'bzrlib.tests.test_ui',
2365
'bzrlib.tests.test_upgrade',
2366
'bzrlib.tests.test_urlutils',
2367
'bzrlib.tests.test_versionedfile',
2368
'bzrlib.tests.test_version',
2369
'bzrlib.tests.test_version_info',
2370
'bzrlib.tests.test_weave',
2371
'bzrlib.tests.test_whitebox',
2372
'bzrlib.tests.test_workingtree',
2373
'bzrlib.tests.test_workingtree_4',
2374
'bzrlib.tests.test_wsgi',
2375
'bzrlib.tests.test_xml',
667
'bzrlib.tests.test_trace',
668
'bzrlib.tests.test_rio',
2377
test_transport_implementations = [
2378
'bzrlib.tests.test_transport_implementations',
2379
'bzrlib.tests.test_read_bundle',
2381
suite = TestUtil.TestSuite()
2382
loader = TestUtil.TestLoader()
2383
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2384
from bzrlib.transport import TransportTestProviderAdapter
2385
adapter = TransportTestProviderAdapter()
2386
adapt_modules(test_transport_implementations, adapter, loader, suite)
671
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
672
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
675
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
2387
676
for package in packages_to_test():
2388
677
suite.addTest(package.test_suite())
2389
678
for m in MODULES_TO_TEST:
2390
suite.addTest(loader.loadTestsFromModule(m))
2391
for m in MODULES_TO_DOCTEST:
2393
suite.addTest(doctest.DocTestSuite(m))
2394
except ValueError, e:
2395
print '**failed to get doctest for: %s\n%s' %(m,e)
2397
for name, plugin in bzrlib.plugin.all_plugins().items():
2398
if getattr(plugin, 'test_suite', None) is not None:
2399
default_encoding = sys.getdefaultencoding()
2401
plugin_suite = plugin.test_suite()
2402
except ImportError, e:
2403
bzrlib.trace.warning(
2404
'Unable to test plugin "%s": %s', name, e)
2406
suite.addTest(plugin_suite)
2407
if default_encoding != sys.getdefaultencoding():
2408
bzrlib.trace.warning(
2409
'Plugin "%s" tried to reset default encoding to: %s', name,
2410
sys.getdefaultencoding())
2412
sys.setdefaultencoding(default_encoding)
679
suite.addTest(TestLoader().loadTestsFromModule(m))
680
for m in (MODULES_TO_DOCTEST):
681
suite.addTest(DocTestSuite(m))
682
for p in bzrlib.plugin.all_plugins:
683
if hasattr(p, 'test_suite'):
684
suite.addTest(p.test_suite())
2416
def adapt_modules(mods_list, adapter, loader, suite):
2417
"""Adapt the modules in mods_list using adapter and add to suite."""
2418
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2419
suite.addTests(adapter.adapt(test))
2422
def _rmtree_temp_dir(dirname):
2424
osutils.rmtree(dirname)
2426
if sys.platform == 'win32' and e.errno == errno.EACCES:
2427
print >>sys.stderr, ('Permission denied: '
2428
'unable to remove testing dir '
2429
'%s' % os.path.basename(dirname))
2434
def clean_selftest_output(root=None, quiet=False):
2435
"""Remove all selftest output directories from root directory.
2437
:param root: root directory for clean
2438
(if ommitted or None then clean current directory).
2439
:param quiet: suppress report about deleting directories
2442
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2445
for i in os.listdir(root):
2446
if os.path.isdir(i) and re_dir.match(i):
2448
print 'delete directory:', i
2452
class Feature(object):
2453
"""An operating system Feature."""
2456
self._available = None
2458
def available(self):
2459
"""Is the feature available?
2461
:return: True if the feature is available.
2463
if self._available is None:
2464
self._available = self._probe()
2465
return self._available
2468
"""Implement this method in concrete features.
2470
:return: True if the feature is available.
2472
raise NotImplementedError
2475
if getattr(self, 'feature_name', None):
2476
return self.feature_name()
2477
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
