90
131
import bzrlib.tests.blackbox
91
132
import bzrlib.tests.branch_implementations
92
133
import bzrlib.tests.bzrdir_implementations
134
import bzrlib.tests.commands
93
135
import bzrlib.tests.interrepository_implementations
94
136
import bzrlib.tests.interversionedfile_implementations
137
import bzrlib.tests.intertree_implementations
138
import bzrlib.tests.inventory_implementations
139
import bzrlib.tests.per_lock
95
140
import bzrlib.tests.repository_implementations
96
141
import bzrlib.tests.revisionstore_implementations
142
import bzrlib.tests.tree_implementations
97
143
import bzrlib.tests.workingtree_implementations
100
146
bzrlib.tests.blackbox,
101
147
bzrlib.tests.branch_implementations,
102
148
bzrlib.tests.bzrdir_implementations,
149
bzrlib.tests.commands,
103
150
bzrlib.tests.interrepository_implementations,
104
151
bzrlib.tests.interversionedfile_implementations,
152
bzrlib.tests.intertree_implementations,
153
bzrlib.tests.inventory_implementations,
154
bzrlib.tests.per_lock,
105
155
bzrlib.tests.repository_implementations,
106
156
bzrlib.tests.revisionstore_implementations,
157
bzrlib.tests.tree_implementations,
107
158
bzrlib.tests.workingtree_implementations,
111
class _MyResult(unittest._TextTestResult):
112
"""Custom TestResult.
114
Shows output in a different format, including displaying runtime for tests.
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.
116
178
stop_early = False
118
def _elapsedTime(self):
119
return "%5dms" % (1000 * (time.time() - self._start_time))
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)
121
244
def startTest(self, test):
122
245
unittest.TestResult.startTest(self, test)
123
# In a short description, the important words are in
124
# the beginning, but in an id, the important words are
126
SHOW_DESCRIPTIONS = False
128
width = osutils.terminal_width()
129
name_width = width - 15
131
if SHOW_DESCRIPTIONS:
132
what = test.shortDescription()
134
if len(what) > name_width:
135
what = what[:name_width-3] + '...'
138
if what.startswith('bzrlib.tests.'):
140
if len(what) > name_width:
141
what = '...' + what[3-name_width:]
142
what = what.ljust(name_width)
143
self.stream.write(what)
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."""
145
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:
147
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)
148
268
if isinstance(err[1], TestSkipped):
149
return self.addSkipped(test, err)
150
unittest.TestResult.addError(self, test, err)
152
self.stream.writeln("ERROR %s" % self._elapsedTime())
154
self.stream.write('E')
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)
159
279
def addFailure(self, test, err):
160
unittest.TestResult.addFailure(self, test, err)
162
self.stream.writeln(" FAIL %s" % self._elapsedTime())
164
self.stream.write('F')
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)
169
295
def addSuccess(self, test):
171
self.stream.writeln(' OK %s' % self._elapsedTime())
173
self.stream.write('~')
175
unittest.TestResult.addSuccess(self, test)
177
def addSkipped(self, test, skip_excinfo):
179
print >>self.stream, ' SKIP %s' % self._elapsedTime()
180
print >>self.stream, ' %s' % skip_excinfo[1]
182
self.stream.write('S')
184
# seems best to treat this as success from point-of-view of unittest
185
# -- it actually does nothing so it barely matters :)
186
unittest.TestResult.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)
188
352
def printErrorList(self, flavour, errors):
189
353
for test, err in errors:
190
354
self.stream.writeln(self.separator1)
191
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
355
self.stream.write("%s: " % flavour)
356
self.stream.writeln(self.getDescription(test))
192
357
if getattr(test, '_get_log', None) is not None:
193
358
print >>self.stream
194
359
print >>self.stream, \
199
364
self.stream.writeln(self.separator2)
200
365
self.stream.writeln("%s" % err)
203
class TextTestRunner(unittest.TextTestRunner):
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):
204
537
stop_on_failure = False
206
def _makeResult(self):
207
result = _MyResult(self.stream, self.descriptions, self.verbosity)
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(),
208
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." %
292
869
if message is None:
293
870
message = "texts not equal:\n"
294
raise AssertionError(message +
295
self._ndiff_strings(a, b))
871
raise AssertionError(message +
872
self._ndiff_strings(a, b))
297
874
def assertEqualMode(self, mode, mode_test):
298
875
self.assertEqual(mode, mode_test,
299
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)
301
886
def assertStartsWith(self, s, prefix):
302
887
if not s.startswith(prefix):
303
888
raise AssertionError('string %r does not start with %r' % (s, prefix))
305
890
def assertEndsWith(self, s, suffix):
306
if not s.endswith(prefix):
891
"""Asserts that s ends with suffix."""
892
if not s.endswith(suffix):
307
893
raise AssertionError('string %r does not end with %r' % (s, suffix))
309
895
def assertContainsRe(self, haystack, needle_re):
310
896
"""Assert that a contains something matching a regular expression."""
311
897
if not re.search(needle_re, haystack):
312
raise AssertionError('pattern "%s" not found in "%s"'
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"'
313
911
% (needle_re, haystack))
315
913
def assertSubset(self, sublist, superlist):
316
914
"""Assert that every entry in sublist is present in superlist."""
318
for entry in sublist:
319
if entry not in superlist:
320
missing.append(entry)
915
missing = set(sublist) - set(superlist)
321
916
if len(missing) > 0:
322
raise AssertionError("value(s) %r not present in container %r" %
917
raise AssertionError("value(s) %r not present in container %r" %
323
918
(missing, superlist))
325
def assertIs(self, left, right):
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):
326
961
if not (left is right):
327
raise AssertionError("%r is not %r." % (left, 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))
329
974
def assertTransportMode(self, transport, path, mode):
330
975
"""Fail if a path does not have mode mode.
341
986
def assertIsInstance(self, obj, kls):
342
987
"""Fail if obj is not an instance of kls"""
343
988
if not isinstance(obj, kls):
344
self.fail("%r is not an instance of %s" % (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)
346
1106
def _startLogFile(self):
347
1107
"""Send bzr and test log messages to a temporary file.
424
1242
# TODO: Perhaps this should keep running cleanups even if
425
1243
# one of them fails?
426
for cleanup_fn in reversed(self._cleanups):
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()()
429
1250
def log(self, *args):
433
"""Return as a string the log for this test"""
434
if self._log_file_name:
435
return open(self._log_file_name).read()
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:
437
1266
return self._log_contents
438
# TODO: Delete the log after it's been read in
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)
440
1288
def capture(self, cmd, retcode=0):
441
1289
"""Shortcut that splits cmd into words, runs, and returns stdout"""
442
1290
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
444
def run_bzr_captured(self, argv, 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,
445
1303
"""Invoke bzr and return (stdout, stderr).
447
Useful for code that wants to check the contents of the
448
output, the way error messages are presented, etc.
450
This should be the main method for tests that want to exercise the
451
overall behavior of the bzr application (rather than a unit test
452
or a functional test of the library.)
454
Much of the old code runs bzr by forking a new copy of Python, but
455
that is slower, harder to debug, and generally not necessary.
457
This runs bzr through the interface that catches and reports
458
errors, and with logging set to something approximating the
459
default, so that error reporting can be checked.
461
argv -- arguments to invoke bzr
462
retcode -- expected return code, or None for don't-care.
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
466
self.log('run bzr: %s', ' '.join(argv))
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)
467
1338
# FIXME: don't call into logging here
468
1339
handler = logging.StreamHandler(stderr)
469
handler.setFormatter(bzrlib.trace.QuietFormatter())
470
1340
handler.setLevel(logging.INFO)
471
1341
logger = logging.getLogger('')
472
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)
474
result = self.apply_redirected(None, stdout, stderr,
475
bzrlib.commands.run_bzr_catch_errors,
1352
result = self.apply_redirected(ui.ui_factory.stdin,
1354
bzrlib.commands.run_bzr_catch_errors,
478
1357
logger.removeHandler(handler)
1358
ui.ui_factory = old_ui_factory
479
1362
out = stdout.getvalue()
480
1363
err = stderr.getvalue()
482
self.log('output:\n%s', out)
1365
self.log('output:\n%r', out)
484
self.log('errors:\n%s', err)
1367
self.log('errors:\n%r', err)
485
1368
if retcode is not None:
486
self.assertEquals(result, retcode)
1369
self.assertEquals(retcode, result,
1370
message='Unexpected return code')
489
1373
def run_bzr(self, *args, **kwargs):
490
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.
492
1394
This should be the main method for tests that want to exercise the
493
1395
overall behavior of the bzr application (rather than a unit test
494
1396
or a functional test of the library.)
496
1398
This sends the stdout/stderr results into the test's log,
497
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.
499
1408
retcode = kwargs.pop('retcode', 0)
500
return self.run_bzr_captured(args, retcode)
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))
502
1621
def check_inventory_shape(self, inv, shape):
503
1622
"""Compare an inventory to a list of expected names.
551
1670
sys.stderr = real_stderr
552
1671
sys.stdin = real_stdin
554
def merge(self, branch_from, wt_to):
555
"""A helper for tests to do a ui-less merge.
557
This should move to the main library when someone has time to integrate
560
# minimal ui-less merge.
561
wt_to.branch.fetch(branch_from)
562
base_rev = common_ancestor(branch_from.last_revision(),
563
wt_to.branch.last_revision(),
564
wt_to.branch.repository)
565
merge_inner(wt_to.branch, branch_from.basis_tree(),
566
wt_to.branch.repository.revision_tree(base_rev),
568
wt_to.add_pending_merge(branch_from.last_revision())
571
BzrTestBase = TestCase
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()
574
class TestCaseInTempDir(TestCase):
1960
class TestCaseInTempDir(TestCaseWithMemoryTransport):
575
1961
"""Derived class that runs a test within a temporary directory.
577
1963
This is useful for tests that need to create a branch, etc.
596
1987
self.log("actually: %r" % contents)
597
1988
self.fail("contents of %s not as expected" % filename)
599
def _make_test_root(self):
600
if TestCaseInTempDir.TEST_ROOT is not None:
604
root = u'test%04d.tmp' % i
608
if e.errno == errno.EEXIST:
613
# successfully created
614
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
616
# make a fake bzr directory there to prevent any tests propagating
617
# up onto the source directory's real branch
618
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
621
super(TestCaseInTempDir, self).setUp()
622
self._make_test_root()
623
_currentdir = os.getcwdu()
624
# shorten the name, to avoid test failures due to path length
625
short_id = self.id().replace('bzrlib.tests.', '') \
626
.replace('__main__.', '')[-100:]
627
# it's possible the same test class is run several times for
628
# parameterized tests, so make sure the names don't collide.
632
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
634
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
635
if os.path.exists(candidate_dir):
639
self.test_dir = candidate_dir
640
os.mkdir(self.test_dir)
641
os.chdir(self.test_dir)
643
os.environ['HOME'] = self.test_dir
644
os.environ['APPDATA'] = self.test_dir
645
def _leaveDirectory():
646
os.chdir(_currentdir)
647
self.addCleanup(_leaveDirectory)
1990
def makeAndChdirToTestDir(self):
1991
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
649
def build_tree(self, shape, line_endings='native', transport=None):
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):
650
2018
"""Build a test tree according to a pattern.
652
2020
shape is a sequence of file specifications. If the final
653
2021
character is '/', a directory is created.
2023
This assumes that all the elements in the tree being built are new.
655
2025
This doesn't add anything to a branch.
656
2027
:param line_endings: Either 'binary' or 'native'
657
in binary mode, exact contents are written
658
in native mode, the line endings match the
659
default platform endings.
661
:param transport: A transport to write to, for building trees on
662
VFS's. If the transport is readonly or None,
663
"." is opened automatically.
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.
665
# XXX: It's OK to just create them using forward slashes on windows?
2034
# It's OK to just create them using forward slashes on windows.
666
2035
if transport is None or transport.is_readonly():
667
2036
transport = get_transport(".")
668
2037
for name in shape:
669
2038
self.assert_(isinstance(name, basestring))
670
2039
if name[-1] == '/':
671
transport.mkdir(urlescape(name[:-1]))
2040
transport.mkdir(urlutils.escape(name[:-1]))
673
2042
if line_endings == 'binary':
675
2044
elif line_endings == 'native':
676
2045
end = os.linesep
678
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
679
content = "contents of %s%s" % (name, end)
680
transport.put(urlescape(name), StringIO(content))
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)
682
2052
def build_tree_contents(self, shape):
683
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)
685
2065
def failUnlessExists(self, path):
686
"""Fail unless path, which may be abs or relative, exists."""
687
self.failUnless(osutils.lexists(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")
689
2073
def failIfExists(self, path):
690
"""Fail if path, which may be abs or relative, exists."""
691
self.failIf(osutils.lexists(path))
693
def assertFileEqual(self, content, path):
694
"""Fail if path does not contain 'content'."""
695
self.failUnless(osutils.lexists(path))
696
self.assertEqualDiff(content, open(path, 'r').read())
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.')
699
2103
class TestCaseWithTransport(TestCaseInTempDir):
710
2114
readwrite one must both define get_url() as resolving to os.getcwd().
713
def __init__(self, methodName='testMethod'):
714
super(TestCaseWithTransport, self).__init__(methodName)
715
self.__readonly_server = None
717
self.transport_server = default_transport
718
self.transport_readonly_server = None
720
def get_readonly_url(self, relpath=None):
721
"""Get a URL for the readonly transport.
723
This will either be backed by '.' or a decorator to the transport
724
used by self.get_url()
725
relpath provides for clients to get a path relative to the base url.
726
These should only be downwards relative, not upwards.
728
base = self.get_readonly_server().get_url()
729
if relpath is not None:
730
if not base.endswith('/'):
732
base = base + relpath
735
def get_readonly_server(self):
736
"""Get the server instance for the readonly transport
738
This is useful for some tests with specific servers to do diagnostics.
740
if self.__readonly_server is None:
741
if self.transport_readonly_server is None:
742
# readonly decorator requested
743
# bring up the server
745
self.__readonly_server = ReadonlyServer()
746
self.__readonly_server.setUp(self.__server)
748
self.__readonly_server = self.transport_readonly_server()
749
self.__readonly_server.setUp()
750
self.addCleanup(self.__readonly_server.tearDown)
751
return self.__readonly_server
753
def get_server(self):
754
"""Get the read/write server instance.
2117
def get_vfs_only_server(self):
2118
"""See TestCaseWithMemoryTransport.
756
2120
This is useful for some tests with specific servers that need
759
if self.__server is None:
760
self.__server = self.transport_server()
761
self.__server.setUp()
762
self.addCleanup(self.__server.tearDown)
765
def get_url(self, relpath=None):
766
"""Get a URL for the readwrite transport.
768
This will either be backed by '.' or to an equivalent non-file based
770
relpath provides for clients to get a path relative to the base url.
771
These should only be downwards relative, not upwards.
773
base = self.get_server().get_url()
774
if relpath is not None and relpath != '.':
775
if not base.endswith('/'):
777
base = base + relpath
780
def get_transport(self):
781
"""Return a writeable transport for the test scratch space"""
782
t = get_transport(self.get_url())
783
self.assertFalse(t.is_readonly())
786
def get_readonly_transport(self):
787
"""Return a readonly transport for the test scratch space
789
This can be used to test that operations which should only need
790
readonly access in fact do not try to write.
792
t = get_transport(self.get_readonly_url())
793
self.assertTrue(t.is_readonly())
796
def make_branch(self, relpath):
797
"""Create a branch on the transport at relpath."""
798
repo = self.make_repository(relpath)
799
return repo.bzrdir.create_branch()
801
def make_bzrdir(self, relpath):
803
url = self.get_url(relpath)
804
segments = relpath.split('/')
805
if segments and segments[-1] not in ('', '.'):
806
parent = self.get_url('/'.join(segments[:-1]))
807
t = get_transport(parent)
809
t.mkdir(segments[-1])
810
except errors.FileExists:
812
return bzrlib.bzrdir.BzrDir.create(url)
813
except errors.UninitializableFormat:
814
raise TestSkipped("Format %s is not initializable.")
816
def make_repository(self, relpath, shared=False):
817
"""Create a repository on our default transport at relpath."""
818
made_control = self.make_bzrdir(relpath)
819
return made_control.create_repository(shared=shared)
821
def make_branch_and_tree(self, relpath):
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):
822
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.
826
2142
# TODO: always use the local disk path for the working tree,
827
2143
# this obviously requires a format that supports branch references
828
2144
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
830
b = self.make_branch(relpath)
2146
b = self.make_branch(relpath, format=format)
832
2148
return b.bzrdir.create_workingtree()
833
2149
except errors.NotLocalUrl:
834
# new formats - catch No tree error and create
835
# a branch reference and a checkout.
836
# old formats at that point - raise TestSkipped.
838
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
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)
840
2161
def assertIsDirectory(self, relpath, transport):
841
2162
"""Assert that relpath within transport is a directory.
868
2202
def setUp(self):
869
2203
super(ChrootedTestCase, self).setUp()
870
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
871
self.transport_readonly_server = bzrlib.transport.http.HttpServer
874
def filter_suite_by_re(suite, pattern):
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
876
2239
filter_re = re.compile(pattern)
2240
if exclude_pattern is not None:
2241
exclude_re = re.compile(exclude_pattern)
877
2242
for test in iter_suite_tests(suite):
878
if filter_re.search(test.id()):
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)
883
2255
def run_suite(suite, name='test', verbose=False, pattern=".*",
884
stop_on_failure=False, keep_output=False,
886
TestCaseInTempDir._TEST_NAME = name
2256
stop_on_failure=False,
2257
transport=None, lsprof_timed=None, bench_history=None,
2258
matching_tests_first=None,
2261
exclude_pattern=None,
2264
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
891
2269
runner = TextTestRunner(stream=sys.stdout,
2271
verbosity=verbosity,
2272
bench_history=bench_history,
2273
list_only=list_only,
894
2275
runner.stop_on_failure=stop_on_failure
896
suite = filter_suite_by_re(suite, pattern)
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,
897
2300
result = runner.run(suite)
898
# This is still a little bogus,
899
# but only a little. Folk not using our testrunner will
900
# have to delete their temp directories themselves.
901
test_root = TestCaseInTempDir.TEST_ROOT
902
if result.wasSuccessful() or not keep_output:
903
if test_root is not None:
904
print 'Deleting test root %s...' % test_root
906
shutil.rmtree(test_root)
910
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
2303
return result.wasStrictlySuccessful()
911
2305
return result.wasSuccessful()
914
2308
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2310
test_suite_factory=None,
2313
matching_tests_first=None,
2316
exclude_pattern=None,
917
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
918
2326
global default_transport
919
2327
if transport is None:
920
2328
transport = default_transport
921
2329
old_transport = default_transport
922
2330
default_transport = transport
2332
if test_suite_factory is None:
2333
suite = test_suite()
2335
suite = test_suite_factory()
925
2336
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
926
stop_on_failure=stop_on_failure, keep_output=keep_output,
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,
929
2347
default_transport = old_transport
933
2350
def test_suite():
934
"""Build and return TestSuite for the whole program."""
935
from doctest import DocTestSuite
937
global MODULES_TO_DOCTEST
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',
940
2359
'bzrlib.tests.test_ancestry',
941
2360
'bzrlib.tests.test_annotate',
942
2361
'bzrlib.tests.test_api',
2362
'bzrlib.tests.test_atomicfile',
943
2363
'bzrlib.tests.test_bad_files',
944
'bzrlib.tests.test_basis_inventory',
945
2364
'bzrlib.tests.test_branch',
2365
'bzrlib.tests.test_branchbuilder',
2366
'bzrlib.tests.test_bugtracker',
2367
'bzrlib.tests.test_bundle',
946
2368
'bzrlib.tests.test_bzrdir',
947
'bzrlib.tests.test_command',
2369
'bzrlib.tests.test_cache_utf8',
2370
'bzrlib.tests.test_commands',
948
2371
'bzrlib.tests.test_commit',
949
2372
'bzrlib.tests.test_commit_merge',
950
2373
'bzrlib.tests.test_config',
951
2374
'bzrlib.tests.test_conflicts',
2375
'bzrlib.tests.test_counted_lock',
952
2376
'bzrlib.tests.test_decorators',
2377
'bzrlib.tests.test_delta',
2378
'bzrlib.tests.test_deprecated_graph',
953
2379
'bzrlib.tests.test_diff',
954
'bzrlib.tests.test_doc_generate',
2380
'bzrlib.tests.test_dirstate',
2381
'bzrlib.tests.test_email_message',
955
2382
'bzrlib.tests.test_errors',
956
2383
'bzrlib.tests.test_escaped_store',
2384
'bzrlib.tests.test_extract',
957
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',
958
2390
'bzrlib.tests.test_gpg',
959
2391
'bzrlib.tests.test_graph',
960
2392
'bzrlib.tests.test_hashcache',
2393
'bzrlib.tests.test_help',
2394
'bzrlib.tests.test_hooks',
961
2395
'bzrlib.tests.test_http',
2396
'bzrlib.tests.test_http_response',
2397
'bzrlib.tests.test_https_ca_bundle',
962
2398
'bzrlib.tests.test_identitymap',
2399
'bzrlib.tests.test_ignores',
2400
'bzrlib.tests.test_index',
2401
'bzrlib.tests.test_info',
963
2402
'bzrlib.tests.test_inv',
964
2403
'bzrlib.tests.test_knit',
2404
'bzrlib.tests.test_lazy_import',
2405
'bzrlib.tests.test_lazy_regex',
965
2406
'bzrlib.tests.test_lockdir',
966
2407
'bzrlib.tests.test_lockable_files',
967
2408
'bzrlib.tests.test_log',
2409
'bzrlib.tests.test_lsprof',
2410
'bzrlib.tests.test_mail_client',
2411
'bzrlib.tests.test_memorytree',
968
2412
'bzrlib.tests.test_merge',
969
2413
'bzrlib.tests.test_merge3',
970
2414
'bzrlib.tests.test_merge_core',
2415
'bzrlib.tests.test_merge_directive',
971
2416
'bzrlib.tests.test_missing',
972
2417
'bzrlib.tests.test_msgeditor',
2418
'bzrlib.tests.test_multiparent',
973
2419
'bzrlib.tests.test_nonascii',
974
2420
'bzrlib.tests.test_options',
975
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',
976
2426
'bzrlib.tests.test_permissions',
977
2427
'bzrlib.tests.test_plugins',
978
2428
'bzrlib.tests.test_progress',
2429
'bzrlib.tests.test_reconfigure',
979
2430
'bzrlib.tests.test_reconcile',
2431
'bzrlib.tests.test_registry',
2432
'bzrlib.tests.test_remote',
980
2433
'bzrlib.tests.test_repository',
2434
'bzrlib.tests.test_revert',
981
2435
'bzrlib.tests.test_revision',
982
2436
'bzrlib.tests.test_revisionnamespaces',
983
'bzrlib.tests.test_revprops',
2437
'bzrlib.tests.test_revisiontree',
984
2438
'bzrlib.tests.test_rio',
985
2439
'bzrlib.tests.test_sampler',
986
2440
'bzrlib.tests.test_selftest',
987
2441
'bzrlib.tests.test_setup',
988
2442
'bzrlib.tests.test_sftp_transport',
2443
'bzrlib.tests.test_smart',
989
2444
'bzrlib.tests.test_smart_add',
2445
'bzrlib.tests.test_smart_transport',
2446
'bzrlib.tests.test_smtp_connection',
990
2447
'bzrlib.tests.test_source',
2448
'bzrlib.tests.test_ssh_transport',
2449
'bzrlib.tests.test_status',
991
2450
'bzrlib.tests.test_store',
2451
'bzrlib.tests.test_strace',
2452
'bzrlib.tests.test_subsume',
992
2453
'bzrlib.tests.test_symbol_versioning',
2454
'bzrlib.tests.test_tag',
993
2455
'bzrlib.tests.test_testament',
2456
'bzrlib.tests.test_textfile',
2457
'bzrlib.tests.test_textmerge',
2458
'bzrlib.tests.test_timestamp',
994
2459
'bzrlib.tests.test_trace',
995
2460
'bzrlib.tests.test_transactions',
996
2461
'bzrlib.tests.test_transform',
997
2462
'bzrlib.tests.test_transport',
2463
'bzrlib.tests.test_tree',
2464
'bzrlib.tests.test_treebuilder',
998
2465
'bzrlib.tests.test_tsort',
2466
'bzrlib.tests.test_tuned_gzip',
999
2467
'bzrlib.tests.test_ui',
1000
2468
'bzrlib.tests.test_upgrade',
2469
'bzrlib.tests.test_urlutils',
1001
2470
'bzrlib.tests.test_versionedfile',
2471
'bzrlib.tests.test_version',
2472
'bzrlib.tests.test_version_info',
1002
2473
'bzrlib.tests.test_weave',
1003
2474
'bzrlib.tests.test_whitebox',
2475
'bzrlib.tests.test_win32utils',
1004
2476
'bzrlib.tests.test_workingtree',
2477
'bzrlib.tests.test_workingtree_4',
2478
'bzrlib.tests.test_wsgi',
1005
2479
'bzrlib.tests.test_xml',
1007
2481
test_transport_implementations = [
1008
'bzrlib.tests.test_transport_implementations']
1010
TestCase.BZRPATH = osutils.pathjoin(
1011
osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
1012
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
1013
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1016
# python2.4's TestLoader.loadTestsFromNames gives very poor
1017
# errors if it fails to load a named module - no indication of what's
1018
# actually wrong, just "no such module". We should probably override that
1019
# class, but for the moment just load them ourselves. (mbp 20051202)
1020
loader = TestLoader()
1021
from bzrlib.transport import TransportTestProviderAdapter
2482
'bzrlib.tests.test_transport_implementations',
2483
'bzrlib.tests.test_read_bundle',
2485
suite = TestUtil.TestSuite()
2486
loader = TestUtil.TestLoader()
2487
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2488
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
1022
2489
adapter = TransportTestProviderAdapter()
1023
2490
adapt_modules(test_transport_implementations, adapter, loader, suite)
1024
for mod_name in testmod_names:
1025
mod = _load_module_by_name(mod_name)
1026
suite.addTest(loader.loadTestsFromModule(mod))
1027
2491
for package in packages_to_test():
1028
2492
suite.addTest(package.test_suite())
1029
2493
for m in MODULES_TO_TEST:
1030
2494
suite.addTest(loader.loadTestsFromModule(m))
1031
for m in (MODULES_TO_DOCTEST):
1032
suite.addTest(DocTestSuite(m))
1033
for name, plugin in bzrlib.plugin.all_plugins().items():
1034
if getattr(plugin, 'test_suite', None) is not None:
1035
suite.addTest(plugin.test_suite())
2495
for m in MODULES_TO_DOCTEST:
2497
suite.addTest(doctest.DocTestSuite(m))
2498
except ValueError, e:
2499
print '**failed to get doctest for: %s\n%s' %(m,e)
2501
default_encoding = sys.getdefaultencoding()
2502
for name, plugin in bzrlib.plugin.plugins().items():
2504
plugin_suite = plugin.test_suite()
2505
except ImportError, e:
2506
bzrlib.trace.warning(
2507
'Unable to test plugin "%s": %s', name, e)
2509
if plugin_suite is not None:
2510
suite.addTest(plugin_suite)
2511
if default_encoding != sys.getdefaultencoding():
2512
bzrlib.trace.warning(
2513
'Plugin "%s" tried to reset default encoding to: %s', name,
2514
sys.getdefaultencoding())
2516
sys.setdefaultencoding(default_encoding)
2520
def multiply_tests_from_modules(module_name_list, scenario_iter):
2521
"""Adapt all tests in some given modules to given scenarios.
2523
This is the recommended public interface for test parameterization.
2524
Typically the test_suite() method for a per-implementation test
2525
suite will call multiply_tests_from_modules and return the
2528
:param module_name_list: List of fully-qualified names of test
2530
:param scenario_iter: Iterable of pairs of (scenario_name,
2531
scenario_param_dict).
2533
This returns a new TestSuite containing the cross product of
2534
all the tests in all the modules, each repeated for each scenario.
2535
Each test is adapted by adding the scenario name at the end
2536
of its name, and updating the test object's __dict__ with the
2537
scenario_param_dict.
2539
>>> r = multiply_tests_from_modules(
2540
... ['bzrlib.tests.test_sampler'],
2541
... [('one', dict(param=1)),
2542
... ('two', dict(param=2))])
2543
>>> tests = list(iter_suite_tests(r))
2547
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2553
loader = TestLoader()
2555
adapter = TestScenarioApplier()
2556
adapter.scenarios = list(scenario_iter)
2557
adapt_modules(module_name_list, adapter, loader, suite)
1039
2561
def adapt_modules(mods_list, adapter, loader, suite):
1040
2562
"""Adapt the modules in mods_list using adapter and add to suite."""
1041
for mod_name in mods_list:
1042
mod = _load_module_by_name(mod_name)
1043
for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
1044
suite.addTests(adapter.adapt(test))
1047
def _load_module_by_name(mod_name):
1048
parts = mod_name.split('.')
1049
module = __import__(mod_name)
1051
# for historical reasons python returns the top-level module even though
1052
# it loads the submodule; we need to walk down to get the one we want.
1054
module = getattr(module, parts.pop(0))
2563
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2564
suite.addTests(adapter.adapt(test))
2567
def _rmtree_temp_dir(dirname):
2568
# If LANG=C we probably have created some bogus paths
2569
# which rmtree(unicode) will fail to delete
2570
# so make sure we are using rmtree(str) to delete everything
2571
# except on win32, where rmtree(str) will fail
2572
# since it doesn't have the property of byte-stream paths
2573
# (they are either ascii or mbcs)
2574
if sys.platform == 'win32':
2575
# make sure we are using the unicode win32 api
2576
dirname = unicode(dirname)
2578
dirname = dirname.encode(sys.getfilesystemencoding())
2580
osutils.rmtree(dirname)
2582
if sys.platform == 'win32' and e.errno == errno.EACCES:
2583
print >>sys.stderr, ('Permission denied: '
2584
'unable to remove testing dir '
2585
'%s' % os.path.basename(dirname))
2590
class Feature(object):
2591
"""An operating system Feature."""
2594
self._available = None
2596
def available(self):
2597
"""Is the feature available?
2599
:return: True if the feature is available.
2601
if self._available is None:
2602
self._available = self._probe()
2603
return self._available
2606
"""Implement this method in concrete features.
2608
:return: True if the feature is available.
2610
raise NotImplementedError
2613
if getattr(self, 'feature_name', None):
2614
return self.feature_name()
2615
return self.__class__.__name__
2618
class _SymlinkFeature(Feature):
2621
return osutils.has_symlinks()
2623
def feature_name(self):
2626
SymlinkFeature = _SymlinkFeature()
2629
class TestScenarioApplier(object):
2630
"""A tool to apply scenarios to tests."""
2632
def adapt(self, test):
2633
"""Return a TestSuite containing a copy of test for each scenario."""
2634
result = unittest.TestSuite()
2635
for scenario in self.scenarios:
2636
result.addTest(self.adapt_test_to_scenario(test, scenario))
2639
def adapt_test_to_scenario(self, test, scenario):
2640
"""Copy test and apply scenario to it.
2642
:param test: A test to adapt.
2643
:param scenario: A tuple describing the scenarion.
2644
The first element of the tuple is the new test id.
2645
The second element is a dict containing attributes to set on the
2647
:return: The adapted test.
2649
from copy import deepcopy
2650
new_test = deepcopy(test)
2651
for name, value in scenario[1].items():
2652
setattr(new_test, name, value)
2653
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2654
new_test.id = lambda: new_id
2658
def probe_unicode_in_user_encoding():
2659
"""Try to encode several unicode strings to use in unicode-aware tests.
2660
Return first successfull match.
2662
:return: (unicode value, encoded plain string value) or (None, None)
2664
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2665
for uni_val in possible_vals:
2667
str_val = uni_val.encode(bzrlib.user_encoding)
2668
except UnicodeEncodeError:
2669
# Try a different character
2672
return uni_val, str_val
added
removed
bzrlib/tests/__init__.py
