143
112
bzrlib.tests.bzrdir_implementations,
144
113
bzrlib.tests.interrepository_implementations,
145
114
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
115
bzrlib.tests.repository_implementations,
149
116
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
117
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
156
"""Accepts, reports and accumulates the results of running tests.
121
class _MyResult(unittest._TextTestResult):
122
"""Custom TestResult.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
124
Shows output in a different format, including displaying runtime for tests.
163
126
stop_early = False
165
def __init__(self, stream, descriptions, verbosity,
168
use_numbered_dirs=False,
170
"""Construct new TestResult.
172
:param bench_history: Optionally, a writable file object to accumulate
128
def __init__(self, stream, descriptions, verbosity, pb=None):
175
129
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
176
if bench_history is not None:
177
from bzrlib.version import _get_bzr_source_tree
178
src_tree = _get_bzr_source_tree()
181
revision_id = src_tree.get_parent_ids()[0]
183
# XXX: if this is a brand new tree, do the same as if there
187
# XXX: If there's no branch, what should we do?
189
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
190
self._bench_history = bench_history
191
self.ui = ui.ui_factory
192
self.num_tests = num_tests
194
self.failure_count = 0
195
self.known_failure_count = 0
197
self.unsupported = {}
199
self.use_numbered_dirs = use_numbered_dirs
200
self._overall_start_time = time.time()
202
132
def extractBenchmarkTime(self, testCase):
203
133
"""Add a benchmark time for the current test case."""
213
143
self._formatTime(self._benchmarkTime),
214
144
self._elapsedTestTimeString())
216
return " %s" % self._elapsedTestTimeString()
146
return " %s" % self._elapsedTestTimeString()
218
148
def _formatTime(self, seconds):
219
149
"""Format seconds as milliseconds with leading spaces."""
220
# some benchmarks can take thousands of seconds to run, so we need 8
222
return "%8dms" % (1000 * seconds)
150
return "%5dms" % (1000 * seconds)
224
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
152
def _ellipsise_unimportant_words(self, a_string, final_width,
154
"""Add ellipses (sp?) for overly long strings.
156
:param keep_start: If true preserve the start of a_string rather
160
if len(a_string) > final_width:
161
result = a_string[:final_width-3] + '...'
165
if len(a_string) > final_width:
166
result = '...' + a_string[3-final_width:]
169
return result.ljust(final_width)
229
171
def startTest(self, test):
230
172
unittest.TestResult.startTest(self, test)
231
self.report_test_start(test)
232
test.number = self.count
173
# In a short description, the important words are in
174
# the beginning, but in an id, the important words are
176
SHOW_DESCRIPTIONS = False
178
if not self.showAll and self.dots and self.pb is not None:
181
final_width = osutils.terminal_width()
182
final_width = final_width - 15 - 8
184
if SHOW_DESCRIPTIONS:
185
what = test.shortDescription()
187
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
190
if what.startswith('bzrlib.tests.'):
192
what = self._ellipsise_unimportant_words(what, final_width)
194
self.stream.write(what)
195
elif self.dots and self.pb is not None:
196
self.pb.update(what, self.testsRun - 1, None)
233
198
self._recordTestStartTime()
235
200
def _recordTestStartTime(self):
236
201
"""Record that a test has started."""
237
202
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
246
204
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
205
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
206
return self.addSkipped(test, err)
253
207
unittest.TestResult.addError(self, test, err)
254
self.error_count += 1
255
self.report_error(test, err)
208
self.extractBenchmarkTime(test)
210
self.stream.writeln("ERROR %s" % self._testTimeString())
211
elif self.dots and self.pb is None:
212
self.stream.write('E')
214
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
256
216
if self.stop_early:
259
219
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
220
unittest.TestResult.addFailure(self, test, err)
265
self.failure_count += 1
266
self.report_failure(test, err)
221
self.extractBenchmarkTime(test)
223
self.stream.writeln(" FAIL %s" % self._testTimeString())
224
elif self.dots and self.pb is None:
225
self.stream.write('F')
227
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
267
229
if self.stop_early:
270
def addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
self.unsupported.setdefault(str(feature), 0)
276
self.unsupported[str(feature)] += 1
277
self.report_unsupported(test, feature)
279
232
def addSuccess(self, test):
280
233
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
235
self.stream.writeln(' OK %s' % self._testTimeString())
236
for bench_called, stats in getattr(test, '_benchcalls', []):
237
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
238
stats.pprint(file=self.stream)
239
elif self.dots and self.pb is None:
240
self.stream.write('~')
242
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
287
244
unittest.TestResult.addSuccess(self, test)
289
246
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
247
self.extractBenchmarkTime(test)
249
print >>self.stream, ' SKIP %s' % self._testTimeString()
250
print >>self.stream, ' %s' % skip_excinfo[1]
251
elif self.dots and self.pb is None:
252
self.stream.write('S')
254
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
291
256
# seems best to treat this as success from point-of-view of unittest
292
257
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
258
unittest.TestResult.addSuccess(self, test)
302
260
def printErrorList(self, flavour, errors):
303
261
for test, err in errors:
304
262
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
263
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
309
264
if getattr(test, '_get_log', None) is not None:
310
265
print >>self.stream
311
266
print >>self.stream, \
316
271
self.stream.writeln(self.separator2)
317
272
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
325
def report_success(self, test):
329
class TextTestResult(ExtendedTestResult):
330
"""Displays progress and results of tests in text form"""
332
def __init__(self, stream, descriptions, verbosity,
336
use_numbered_dirs=False,
338
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
346
self.pb.show_pct = False
347
self.pb.show_spinner = False
348
self.pb.show_eta = False,
349
self.pb.show_count = False
350
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
355
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
358
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
373
def report_test_start(self, test):
376
self._progress_prefix_text()
378
+ self._shortened_test_description(test))
380
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
387
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
389
self._test_description(test),
393
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
395
self._test_description(test),
399
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
419
def report_unsupported(self, test, feature):
420
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
class VerboseTestResult(ExtendedTestResult):
431
"""Produce long output, with one line per test run plus times"""
433
def _ellipsize_to_right(self, a_string, final_width):
434
"""Truncate and pad a string, keeping the right hand side"""
435
if len(a_string) > final_width:
436
result = '...' + a_string[3-final_width:]
439
return result.ljust(final_width)
441
def report_starting(self):
442
self.stream.write('running %d tests...\n' % self.num_tests)
444
def report_test_start(self, test):
446
name = self._shortened_test_description(test)
447
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
448
# numbers, plus a trailing blank
449
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
450
if self.use_numbered_dirs:
451
self.stream.write('%5d ' % self.count)
452
self.stream.write(self._ellipsize_to_right(name,
453
osutils.terminal_width()-36))
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
if self.use_numbered_dirs:
463
return '%s%s' % (indent, err[1])
465
def report_error(self, test, err):
466
self.stream.writeln('ERROR %s\n%s'
467
% (self._testTimeString(),
468
self._error_summary(err)))
470
def report_failure(self, test, err):
471
self.stream.writeln(' FAIL %s\n%s'
472
% (self._testTimeString(),
473
self._error_summary(err)))
475
def report_known_failure(self, test, err):
476
self.stream.writeln('XFAIL %s\n%s'
477
% (self._testTimeString(),
478
self._error_summary(err)))
480
def report_success(self, test):
481
self.stream.writeln(' OK %s' % self._testTimeString())
482
for bench_called, stats in getattr(test, '_benchcalls', []):
483
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
484
stats.pprint(file=self.stream)
485
# flush the stream so that we get smooth output. This verbose mode is
486
# used to show the output in PQM.
489
def report_skip(self, test, skip_excinfo):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(),
493
self._error_summary(skip_excinfo)))
495
def report_unsupported(self, test, feature):
496
"""test cannot be run because feature is missing."""
497
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
498
%(self._testTimeString(), feature))
502
275
class TextTestRunner(object):
503
276
stop_on_failure = False
872
488
raise AssertionError("value(s) %r not present in container %r" %
873
489
(missing, superlist))
875
def assertListRaises(self, excClass, func, *args, **kwargs):
876
"""Fail unless excClass is raised when the iterator from func is used.
878
Many functions can return generators this makes sure
879
to wrap them in a list() call to make sure the whole generator
880
is run, and that the proper exception is raised.
883
list(func(*args, **kwargs))
887
if getattr(excClass,'__name__', None) is not None:
888
excName = excClass.__name__
890
excName = str(excClass)
891
raise self.failureException, "%s not raised" % excName
893
def assertRaises(self, excClass, callableObj, *args, **kwargs):
894
"""Assert that a callable raises a particular exception.
896
:param excClass: As for the except statement, this may be either an
897
exception class, or a tuple of classes.
898
:param callableObj: A callable, will be passed ``*args`` and
901
Returns the exception so that you can examine it.
904
callableObj(*args, **kwargs)
908
if getattr(excClass,'__name__', None) is not None:
909
excName = excClass.__name__
912
excName = str(excClass)
913
raise self.failureException, "%s not raised" % excName
915
def assertIs(self, left, right, message=None):
491
def assertIs(self, left, right):
916
492
if not (left is right):
917
if message is not None:
918
raise AssertionError(message)
920
raise AssertionError("%r is not %r." % (left, right))
922
def assertIsNot(self, left, right, message=None):
924
if message is not None:
925
raise AssertionError(message)
927
raise AssertionError("%r is %r." % (left, right))
493
raise AssertionError("%r is not %r." % (left, right))
929
495
def assertTransportMode(self, transport, path, mode):
930
496
"""Fail if a path does not have mode mode.
944
510
self.fail("%r is an instance of %s rather than %s" % (
945
511
obj, obj.__class__, kls))
947
def expectFailure(self, reason, assertion, *args, **kwargs):
948
"""Invoke a test, expecting it to fail for the given reason.
950
This is for assertions that ought to succeed, but currently fail.
951
(The failure is *expected* but not *wanted*.) Please be very precise
952
about the failure you're expecting. If a new bug is introduced,
953
AssertionError should be raised, not KnownFailure.
955
Frequently, expectFailure should be followed by an opposite assertion.
958
Intended to be used with a callable that raises AssertionError as the
959
'assertion' parameter. args and kwargs are passed to the 'assertion'.
961
Raises KnownFailure if the test fails. Raises AssertionError if the
966
self.expectFailure('Math is broken', self.assertNotEqual, 54,
968
self.assertEqual(42, dynamic_val)
970
This means that a dynamic_val of 54 will cause the test to raise
971
a KnownFailure. Once math is fixed and the expectFailure is removed,
972
only a dynamic_val of 42 will allow the test to pass. Anything other
973
than 54 or 42 will cause an AssertionError.
976
assertion(*args, **kwargs)
977
except AssertionError:
978
raise KnownFailure(reason)
980
self.fail('Unexpected success. Should have failed: %s' % reason)
982
def _capture_warnings(self, a_callable, *args, **kwargs):
983
"""A helper for callDeprecated and applyDeprecated.
985
:param a_callable: A callable to call.
986
:param args: The positional arguments for the callable
987
:param kwargs: The keyword arguments for the callable
988
:return: A tuple (warnings, result). result is the result of calling
989
a_callable(``*args``, ``**kwargs``).
992
def capture_warnings(msg, cls=None, stacklevel=None):
993
# we've hooked into a deprecation specific callpath,
994
# only deprecations should getting sent via it.
995
self.assertEqual(cls, DeprecationWarning)
996
local_warnings.append(msg)
997
original_warning_method = symbol_versioning.warn
998
symbol_versioning.set_warning_method(capture_warnings)
1000
result = a_callable(*args, **kwargs)
1002
symbol_versioning.set_warning_method(original_warning_method)
1003
return (local_warnings, result)
1005
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1006
"""Call a deprecated callable without warning the user.
1008
Note that this only captures warnings raised by symbol_versioning.warn,
1009
not other callers that go direct to the warning module.
1011
:param deprecation_format: The deprecation format that the callable
1012
should have been deprecated with. This is the same type as the
1013
parameter to deprecated_method/deprecated_function. If the
1014
callable is not deprecated with this format, an assertion error
1016
:param a_callable: A callable to call. This may be a bound method or
1017
a regular function. It will be called with ``*args`` and
1019
:param args: The positional arguments for the callable
1020
:param kwargs: The keyword arguments for the callable
1021
:return: The result of a_callable(``*args``, ``**kwargs``)
1023
call_warnings, result = self._capture_warnings(a_callable,
1025
expected_first_warning = symbol_versioning.deprecation_string(
1026
a_callable, deprecation_format)
1027
if len(call_warnings) == 0:
1028
self.fail("No deprecation warning generated by call to %s" %
1030
self.assertEqual(expected_first_warning, call_warnings[0])
1033
def callDeprecated(self, expected, callable, *args, **kwargs):
1034
"""Assert that a callable is deprecated in a particular way.
1036
This is a very precise test for unusual requirements. The
1037
applyDeprecated helper function is probably more suited for most tests
1038
as it allows you to simply specify the deprecation format being used
1039
and will ensure that that is issued for the function being called.
1041
Note that this only captures warnings raised by symbol_versioning.warn,
1042
not other callers that go direct to the warning module.
1044
:param expected: a list of the deprecation warnings expected, in order
1045
:param callable: The callable to call
1046
:param args: The positional arguments for the callable
1047
:param kwargs: The keyword arguments for the callable
1049
call_warnings, result = self._capture_warnings(callable,
1051
self.assertEqual(expected, call_warnings)
1054
513
def _startLogFile(self):
1055
514
"""Send bzr and test log messages to a temporary file.
1057
516
The file is removed as the test is torn down.
1059
518
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1060
self._log_file = os.fdopen(fileno, 'w+')
519
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
520
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
1061
521
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1062
522
self._log_file_name = name
1063
523
self.addCleanup(self._finishLogFile)
1094
548
def _cleanEnvironment(self):
1096
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1097
550
'HOME': os.getcwd(),
1098
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1100
'BZREMAIL': None, # may still be present in the environment
551
'APPDATA': os.getcwd(),
1102
'BZR_PROGRESS_BAR': None,
1106
'https_proxy': None,
1107
'HTTPS_PROXY': None,
1112
# Nobody cares about these ones AFAIK. So far at
1113
# least. If you do (care), please update this comment
1117
'BZR_REMOTE_PATH': None,
1119
555
self.__old_env = {}
1120
556
self.addCleanup(self._restoreEnvironment)
1121
557
for name, value in new_env.iteritems():
1122
558
self._captureVar(name, value)
1124
561
def _captureVar(self, name, newvalue):
1125
"""Set an environment variable, and reset it when finished."""
1126
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
562
"""Set an environment variable, preparing it to be reset when finished."""
563
self.__old_env[name] = os.environ.get(name, None)
565
if name in os.environ:
568
os.environ[name] = newvalue
1128
def _restore_debug_flags(self):
1129
debug.debug_flags.clear()
1130
debug.debug_flags.update(self._preserved_debug_flags)
571
def _restoreVar(name, value):
573
if name in os.environ:
576
os.environ[name] = value
1132
578
def _restoreEnvironment(self):
1133
579
for name, value in self.__old_env.iteritems():
1134
osutils.set_or_unset_env(name, value)
1136
def _restoreHooks(self):
1137
for klass, hooks in self._preserved_hooks.items():
1138
setattr(klass, 'hooks', hooks)
1140
def knownFailure(self, reason):
1141
"""This test has failed for some known reason."""
1142
raise KnownFailure(reason)
1144
def run(self, result=None):
1145
if result is None: result = self.defaultTestResult()
1146
for feature in getattr(self, '_test_needs_features', []):
1147
if not feature.available():
1148
result.startTest(self)
1149
if getattr(result, 'addNotSupported', None):
1150
result.addNotSupported(self, feature)
1152
result.addSuccess(self)
1153
result.stopTest(self)
1155
return unittest.TestCase.run(self, result)
580
self._restoreVar(name, value)
1157
582
def tearDown(self):
1158
583
self._runCleanups()
1188
613
# TODO: Perhaps this should keep running cleanups even if
1189
614
# one of them fails?
1191
# Actually pop the cleanups from the list so tearDown running
1192
# twice is safe (this happens for skipped tests).
1193
while self._cleanups:
1194
self._cleanups.pop()()
615
for cleanup_fn in reversed(self._cleanups):
1196
618
def log(self, *args):
1199
def _get_log(self, keep_log_file=False):
1200
"""Return as a string the log for this test. If the file is still
1201
on disk and keep_log_file=False, delete the log file and store the
1202
content in self._log_contents."""
1203
# flush the log file, to get all content
1205
bzrlib.trace._trace_file.flush()
1206
if self._log_contents:
622
"""Return as a string the log for this test"""
623
if self._log_file_name:
624
return open(self._log_file_name).read()
1207
626
return self._log_contents
1208
if self._log_file_name is not None:
1209
logfile = open(self._log_file_name)
1211
log_contents = logfile.read()
1214
if not keep_log_file:
1215
self._log_contents = log_contents
1217
os.remove(self._log_file_name)
1219
if sys.platform == 'win32' and e.errno == errno.EACCES:
1220
print >>sys.stderr, ('Unable to delete log file '
1221
' %r' % self._log_file_name)
1226
return "DELETED log file to reduce memory footprint"
627
# TODO: Delete the log after it's been read in
1228
@deprecated_method(zero_eighteen)
1229
629
def capture(self, cmd, retcode=0):
1230
630
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1231
631
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1233
def requireFeature(self, feature):
1234
"""This test requires a specific feature is available.
1236
:raises UnavailableFeature: When feature is not available.
1238
if not feature.available():
1239
raise UnavailableFeature(feature)
1241
@deprecated_method(zero_eighteen)
1242
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
633
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
1244
634
"""Invoke bzr and return (stdout, stderr).
1246
Don't call this method, just use run_bzr() which is equivalent.
1248
:param argv: Arguments to invoke bzr. This may be either a
1249
single string, in which case it is split by shlex into words,
1250
or a list of arguments.
1251
:param retcode: Expected return code, or None for don't-care.
1252
:param encoding: Encoding for sys.stdout and sys.stderr
636
Useful for code that wants to check the contents of the
637
output, the way error messages are presented, etc.
639
This should be the main method for tests that want to exercise the
640
overall behavior of the bzr application (rather than a unit test
641
or a functional test of the library.)
643
Much of the old code runs bzr by forking a new copy of Python, but
644
that is slower, harder to debug, and generally not necessary.
646
This runs bzr through the interface that catches and reports
647
errors, and with logging set to something approximating the
648
default, so that error reporting can be checked.
650
:param argv: arguments to invoke bzr
651
:param retcode: expected return code, or None for don't-care.
652
:param encoding: encoding for sys.stdout and sys.stderr
1253
653
:param stdin: A string to be used as stdin for the command.
1254
:param working_dir: Change to this directory before running
1256
return self._run_bzr_autosplit(argv, retcode=retcode,
1257
encoding=encoding, stdin=stdin, working_dir=working_dir,
1260
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1262
"""Run bazaar command line, splitting up a string command line."""
1263
if isinstance(args, basestring):
1264
args = list(shlex.split(args))
1265
return self._run_bzr_core(args, retcode=retcode,
1266
encoding=encoding, stdin=stdin, working_dir=working_dir,
1269
def _run_bzr_core(self, args, retcode, encoding, stdin,
1271
655
if encoding is None:
1272
656
encoding = bzrlib.user_encoding
657
if stdin is not None:
658
stdin = StringIO(stdin)
1273
659
stdout = StringIOWrapper()
1274
660
stderr = StringIOWrapper()
1275
661
stdout.encoding = encoding
1276
662
stderr.encoding = encoding
1278
self.log('run bzr: %r', args)
664
self.log('run bzr: %r', argv)
1279
665
# FIXME: don't call into logging here
1280
666
handler = logging.StreamHandler(stderr)
667
handler.setFormatter(bzrlib.trace.QuietFormatter())
1281
668
handler.setLevel(logging.INFO)
1282
669
logger = logging.getLogger('')
1283
670
logger.addHandler(handler)
1284
old_ui_factory = ui.ui_factory
1285
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1288
if working_dir is not None:
1289
cwd = osutils.getcwd()
1290
os.chdir(working_dir)
671
old_ui_factory = bzrlib.ui.ui_factory
672
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
675
bzrlib.ui.ui_factory.stdin = stdin
1293
result = self.apply_redirected(ui.ui_factory.stdin,
1295
bzrlib.commands.run_bzr_catch_errors,
677
result = self.apply_redirected(stdin, stdout, stderr,
678
bzrlib.commands.run_bzr_catch_errors,
1298
681
logger.removeHandler(handler)
1299
ui.ui_factory = old_ui_factory
682
bzrlib.ui.ui_factory = old_ui_factory
1303
684
out = stdout.getvalue()
1304
685
err = stderr.getvalue()
1339
701
This sends the stdout/stderr results into the test's log,
1340
702
where it may be useful for debugging. See also run_captured.
1342
:keyword stdin: A string to be used as stdin for the command.
1343
:keyword retcode: The status code the command should return;
1345
:keyword working_dir: The directory to run the command in
1346
:keyword error_regexes: A list of expected error messages. If
1347
specified they must be seen in the error output of the command.
704
:param stdin: A string to be used as stdin for the command.
1349
706
retcode = kwargs.pop('retcode', 0)
1350
707
encoding = kwargs.pop('encoding', None)
1351
708
stdin = kwargs.pop('stdin', None)
1352
working_dir = kwargs.pop('working_dir', None)
1353
error_regexes = kwargs.pop('error_regexes', [])
1356
if isinstance(args[0], (list, basestring)):
1359
## symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1360
## DeprecationWarning, stacklevel=2)
1361
# not done yet, because too many tests would need to be updated -
1362
# but please don't do this in new code. -- mbp 20070626
1365
out, err = self._run_bzr_autosplit(args=args,
1367
encoding=encoding, stdin=stdin, working_dir=working_dir,
1370
for regex in error_regexes:
1371
self.assertContainsRe(err, regex)
709
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
1374
711
def run_bzr_decode(self, *args, **kwargs):
1375
if 'encoding' in kwargs:
712
if kwargs.has_key('encoding'):
1376
713
encoding = kwargs['encoding']
1378
715
encoding = bzrlib.user_encoding
1379
716
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1381
def run_bzr_error(self, error_regexes, *args, **kwargs):
1382
"""Run bzr, and check that stderr contains the supplied regexes
1384
:param error_regexes: Sequence of regular expressions which
1385
must each be found in the error output. The relative ordering
1387
:param args: command-line arguments for bzr
1388
:param kwargs: Keyword arguments which are interpreted by run_bzr
1389
This function changes the default value of retcode to be 3,
1390
since in most cases this is run when you expect bzr to fail.
1391
:return: (out, err) The actual output of running the command (in case
1392
you want to do more inspection)
1396
# Make sure that commit is failing because there is nothing to do
1397
self.run_bzr_error(['no changes to commit'],
1398
'commit', '-m', 'my commit comment')
1399
# Make sure --strict is handling an unknown file, rather than
1400
# giving us the 'nothing to do' error
1401
self.build_tree(['unknown'])
1402
self.run_bzr_error(['Commit refused because there are unknown files'],
1403
'commit', '--strict', '-m', 'my commit comment')
1405
kwargs.setdefault('retcode', 3)
1406
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1409
def run_bzr_subprocess(self, *args, **kwargs):
1410
"""Run bzr in a subprocess for testing.
1412
This starts a new Python interpreter and runs bzr in there.
1413
This should only be used for tests that have a justifiable need for
1414
this isolation: e.g. they are testing startup time, or signal
1415
handling, or early startup code, etc. Subprocess code can't be
1416
profiled or debugged so easily.
1418
:keyword retcode: The status code that is expected. Defaults to 0. If
1419
None is supplied, the status code is not checked.
1420
:keyword env_changes: A dictionary which lists changes to environment
1421
variables. A value of None will unset the env variable.
1422
The values must be strings. The change will only occur in the
1423
child, so you don't need to fix the environment after running.
1424
:keyword universal_newlines: Convert CRLF => LF
1425
:keyword allow_plugins: By default the subprocess is run with
1426
--no-plugins to ensure test reproducibility. Also, it is possible
1427
for system-wide plugins to create unexpected output on stderr,
1428
which can cause unnecessary test failures.
1430
env_changes = kwargs.get('env_changes', {})
1431
working_dir = kwargs.get('working_dir', None)
1432
allow_plugins = kwargs.get('allow_plugins', False)
1433
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1434
working_dir=working_dir,
1435
allow_plugins=allow_plugins)
1436
# We distinguish between retcode=None and retcode not passed.
1437
supplied_retcode = kwargs.get('retcode', 0)
1438
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1439
universal_newlines=kwargs.get('universal_newlines', False),
1442
def start_bzr_subprocess(self, process_args, env_changes=None,
1443
skip_if_plan_to_signal=False,
1445
allow_plugins=False):
1446
"""Start bzr in a subprocess for testing.
1448
This starts a new Python interpreter and runs bzr in there.
1449
This should only be used for tests that have a justifiable need for
1450
this isolation: e.g. they are testing startup time, or signal
1451
handling, or early startup code, etc. Subprocess code can't be
1452
profiled or debugged so easily.
1454
:param process_args: a list of arguments to pass to the bzr executable,
1455
for example ``['--version']``.
1456
:param env_changes: A dictionary which lists changes to environment
1457
variables. A value of None will unset the env variable.
1458
The values must be strings. The change will only occur in the
1459
child, so you don't need to fix the environment after running.
1460
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1462
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1464
:returns: Popen object for the started process.
1466
if skip_if_plan_to_signal:
1467
if not getattr(os, 'kill', None):
1468
raise TestSkipped("os.kill not available.")
1470
if env_changes is None:
1474
def cleanup_environment():
1475
for env_var, value in env_changes.iteritems():
1476
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1478
def restore_environment():
1479
for env_var, value in old_env.iteritems():
1480
osutils.set_or_unset_env(env_var, value)
1482
bzr_path = self.get_bzr_path()
1485
if working_dir is not None:
1486
cwd = osutils.getcwd()
1487
os.chdir(working_dir)
1490
# win32 subprocess doesn't support preexec_fn
1491
# so we will avoid using it on all platforms, just to
1492
# make sure the code path is used, and we don't break on win32
1493
cleanup_environment()
1494
command = [sys.executable, bzr_path]
1495
if not allow_plugins:
1496
command.append('--no-plugins')
1497
command.extend(process_args)
1498
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1500
restore_environment()
1506
def _popen(self, *args, **kwargs):
1507
"""Place a call to Popen.
1509
Allows tests to override this method to intercept the calls made to
1510
Popen for introspection.
1512
return Popen(*args, **kwargs)
1514
def get_bzr_path(self):
1515
"""Return the path of the 'bzr' executable for this test suite."""
1516
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1517
if not os.path.isfile(bzr_path):
1518
# We are probably installed. Assume sys.argv is the right file
1519
bzr_path = sys.argv[0]
1522
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1523
universal_newlines=False, process_args=None):
1524
"""Finish the execution of process.
1526
:param process: the Popen object returned from start_bzr_subprocess.
1527
:param retcode: The status code that is expected. Defaults to 0. If
1528
None is supplied, the status code is not checked.
1529
:param send_signal: an optional signal to send to the process.
1530
:param universal_newlines: Convert CRLF => LF
1531
:returns: (stdout, stderr)
1533
if send_signal is not None:
1534
os.kill(process.pid, send_signal)
1535
out, err = process.communicate()
1537
if universal_newlines:
1538
out = out.replace('\r\n', '\n')
1539
err = err.replace('\r\n', '\n')
1541
if retcode is not None and retcode != process.returncode:
1542
if process_args is None:
1543
process_args = "(unknown args)"
1544
mutter('Output of bzr %s:\n%s', process_args, out)
1545
mutter('Error for bzr %s:\n%s', process_args, err)
1546
self.fail('Command bzr %s failed with retcode %s != %s'
1547
% (process_args, retcode, process.returncode))
1550
718
def check_inventory_shape(self, inv, shape):
1551
719
"""Compare an inventory to a list of expected names.
1599
767
sys.stderr = real_stderr
1600
768
sys.stdin = real_stdin
1602
def reduceLockdirTimeout(self):
1603
"""Reduce the default lock timeout for the duration of the test, so that
1604
if LockContention occurs during a test, it does so quickly.
1606
Tests that expect to provoke LockContention errors should call this.
1608
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1610
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1611
self.addCleanup(resetTimeout)
1612
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1615
class TestCaseWithMemoryTransport(TestCase):
1616
"""Common test class for tests that do not need disk resources.
1618
Tests that need disk resources should derive from TestCaseWithTransport.
1620
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1622
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1623
a directory which does not exist. This serves to help ensure test isolation
1624
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1625
must exist. However, TestCaseWithMemoryTransport does not offer local
1626
file defaults for the transport in tests, nor does it obey the command line
1627
override, so tests that accidentally write to the common directory should
1630
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1631
a .bzr directory that stops us ascending higher into the filesystem.
1637
def __init__(self, methodName='runTest'):
1638
# allow test parameterisation after test construction and before test
1639
# execution. Variables that the parameteriser sets need to be
1640
# ones that are not set by setUp, or setUp will trash them.
1641
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1642
self.vfs_transport_factory = default_transport
1643
self.transport_server = None
1644
self.transport_readonly_server = None
1645
self.__vfs_server = None
1647
def get_transport(self, relpath=None):
1648
"""Return a writeable transport.
1650
This transport is for the test scratch space relative to
1653
:param relpath: a path relative to the base url.
1655
t = get_transport(self.get_url(relpath))
1656
self.assertFalse(t.is_readonly())
1659
def get_readonly_transport(self, relpath=None):
1660
"""Return a readonly transport for the test scratch space
1662
This can be used to test that operations which should only need
1663
readonly access in fact do not try to write.
1665
:param relpath: a path relative to the base url.
1667
t = get_transport(self.get_readonly_url(relpath))
1668
self.assertTrue(t.is_readonly())
1671
def create_transport_readonly_server(self):
1672
"""Create a transport server from class defined at init.
1674
This is mostly a hook for daughter classes.
1676
return self.transport_readonly_server()
1678
def get_readonly_server(self):
1679
"""Get the server instance for the readonly transport
1681
This is useful for some tests with specific servers to do diagnostics.
1683
if self.__readonly_server is None:
1684
if self.transport_readonly_server is None:
1685
# readonly decorator requested
1686
# bring up the server
1687
self.__readonly_server = ReadonlyServer()
1688
self.__readonly_server.setUp(self.get_vfs_only_server())
1690
self.__readonly_server = self.create_transport_readonly_server()
1691
self.__readonly_server.setUp(self.get_vfs_only_server())
1692
self.addCleanup(self.__readonly_server.tearDown)
1693
return self.__readonly_server
1695
def get_readonly_url(self, relpath=None):
1696
"""Get a URL for the readonly transport.
1698
This will either be backed by '.' or a decorator to the transport
1699
used by self.get_url()
1700
relpath provides for clients to get a path relative to the base url.
1701
These should only be downwards relative, not upwards.
1703
base = self.get_readonly_server().get_url()
1704
return self._adjust_url(base, relpath)
1706
def get_vfs_only_server(self):
1707
"""Get the vfs only read/write server instance.
1709
This is useful for some tests with specific servers that need
1712
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1713
is no means to override it.
1715
if self.__vfs_server is None:
1716
self.__vfs_server = MemoryServer()
1717
self.__vfs_server.setUp()
1718
self.addCleanup(self.__vfs_server.tearDown)
1719
return self.__vfs_server
1721
def get_server(self):
1722
"""Get the read/write server instance.
1724
This is useful for some tests with specific servers that need
1727
This is built from the self.transport_server factory. If that is None,
1728
then the self.get_vfs_server is returned.
1730
if self.__server is None:
1731
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1732
return self.get_vfs_only_server()
1734
# bring up a decorated means of access to the vfs only server.
1735
self.__server = self.transport_server()
1737
self.__server.setUp(self.get_vfs_only_server())
1738
except TypeError, e:
1739
# This should never happen; the try:Except here is to assist
1740
# developers having to update code rather than seeing an
1741
# uninformative TypeError.
1742
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1743
self.addCleanup(self.__server.tearDown)
1744
return self.__server
1746
def _adjust_url(self, base, relpath):
1747
"""Get a URL (or maybe a path) for the readwrite transport.
1749
This will either be backed by '.' or to an equivalent non-file based
1751
relpath provides for clients to get a path relative to the base url.
1752
These should only be downwards relative, not upwards.
1754
if relpath is not None and relpath != '.':
1755
if not base.endswith('/'):
1757
# XXX: Really base should be a url; we did after all call
1758
# get_url()! But sometimes it's just a path (from
1759
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1760
# to a non-escaped local path.
1761
if base.startswith('./') or base.startswith('/'):
1764
base += urlutils.escape(relpath)
1767
def get_url(self, relpath=None):
1768
"""Get a URL (or maybe a path) for the readwrite transport.
1770
This will either be backed by '.' or to an equivalent non-file based
1772
relpath provides for clients to get a path relative to the base url.
1773
These should only be downwards relative, not upwards.
1775
base = self.get_server().get_url()
1776
return self._adjust_url(base, relpath)
1778
def get_vfs_only_url(self, relpath=None):
1779
"""Get a URL (or maybe a path for the plain old vfs transport.
1781
This will never be a smart protocol. It always has all the
1782
capabilities of the local filesystem, but it might actually be a
1783
MemoryTransport or some other similar virtual filesystem.
1785
This is the backing transport (if any) of the server returned by
1786
get_url and get_readonly_url.
1788
:param relpath: provides for clients to get a path relative to the base
1789
url. These should only be downwards relative, not upwards.
1792
base = self.get_vfs_only_server().get_url()
1793
return self._adjust_url(base, relpath)
1795
def _make_test_root(self):
1796
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1798
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1799
TestCaseWithMemoryTransport.TEST_ROOT = root
1801
# make a fake bzr directory there to prevent any tests propagating
1802
# up onto the source directory's real branch
1803
bzrdir.BzrDir.create_standalone_workingtree(root)
1805
# The same directory is used by all tests, and we're not specifically
1806
# told when all tests are finished. This will do.
1807
atexit.register(_rmtree_temp_dir, root)
1809
def makeAndChdirToTestDir(self):
1810
"""Create a temporary directories for this one test.
1812
This must set self.test_home_dir and self.test_dir and chdir to
1815
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1817
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1818
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1819
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1821
def make_branch(self, relpath, format=None):
1822
"""Create a branch on the transport at relpath."""
1823
repo = self.make_repository(relpath, format=format)
1824
return repo.bzrdir.create_branch()
1826
def make_bzrdir(self, relpath, format=None):
1828
# might be a relative or absolute path
1829
maybe_a_url = self.get_url(relpath)
1830
segments = maybe_a_url.rsplit('/', 1)
1831
t = get_transport(maybe_a_url)
1832
if len(segments) > 1 and segments[-1] not in ('', '.'):
1836
if isinstance(format, basestring):
1837
format = bzrdir.format_registry.make_bzrdir(format)
1838
return format.initialize_on_transport(t)
1839
except errors.UninitializableFormat:
1840
raise TestSkipped("Format %s is not initializable." % format)
1842
def make_repository(self, relpath, shared=False, format=None):
1843
"""Create a repository on our default transport at relpath.
1845
Note that relpath must be a relative path, not a full url.
1847
# FIXME: If you create a remoterepository this returns the underlying
1848
# real format, which is incorrect. Actually we should make sure that
1849
# RemoteBzrDir returns a RemoteRepository.
1850
# maybe mbp 20070410
1851
made_control = self.make_bzrdir(relpath, format=format)
1852
return made_control.create_repository(shared=shared)
1854
def make_branch_and_memory_tree(self, relpath, format=None):
1855
"""Create a branch on the default transport and a MemoryTree for it."""
1856
b = self.make_branch(relpath, format=format)
1857
return memorytree.MemoryTree.create_on_branch(b)
1859
def overrideEnvironmentForTesting(self):
1860
os.environ['HOME'] = self.test_home_dir
1861
os.environ['BZR_HOME'] = self.test_home_dir
1864
super(TestCaseWithMemoryTransport, self).setUp()
1865
self._make_test_root()
1866
_currentdir = os.getcwdu()
1867
def _leaveDirectory():
1868
os.chdir(_currentdir)
1869
self.addCleanup(_leaveDirectory)
1870
self.makeAndChdirToTestDir()
1871
self.overrideEnvironmentForTesting()
1872
self.__readonly_server = None
1873
self.__server = None
1874
self.reduceLockdirTimeout()
770
def merge(self, branch_from, wt_to):
771
"""A helper for tests to do a ui-less merge.
773
This should move to the main library when someone has time to integrate
776
# minimal ui-less merge.
777
wt_to.branch.fetch(branch_from)
778
base_rev = common_ancestor(branch_from.last_revision(),
779
wt_to.branch.last_revision(),
780
wt_to.branch.repository)
781
merge_inner(wt_to.branch, branch_from.basis_tree(),
782
wt_to.branch.repository.revision_tree(base_rev),
784
wt_to.add_pending_merge(branch_from.last_revision())
787
BzrTestBase = TestCase
1877
class TestCaseInTempDir(TestCaseWithMemoryTransport):
790
class TestCaseInTempDir(TestCase):
1878
791
"""Derived class that runs a test within a temporary directory.
1880
793
This is useful for tests that need to create a branch, etc.
1905
812
self.log("actually: %r" % contents)
1906
813
self.fail("contents of %s not as expected" % filename)
1908
def makeAndChdirToTestDir(self):
1909
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
815
def _make_test_root(self):
816
if TestCaseInTempDir.TEST_ROOT is not None:
820
root = u'test%04d.tmp' % i
824
if e.errno == errno.EEXIST:
829
# successfully created
830
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
832
# make a fake bzr directory there to prevent any tests propagating
833
# up onto the source directory's real branch
834
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
837
super(TestCaseInTempDir, self).setUp()
838
self._make_test_root()
839
_currentdir = os.getcwdu()
840
# shorten the name, to avoid test failures due to path length
841
short_id = self.id().replace('bzrlib.tests.', '') \
842
.replace('__main__.', '')[-100:]
843
# it's possible the same test class is run several times for
844
# parameterized tests, so make sure the names don't collide.
848
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
850
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
851
if os.path.exists(candidate_dir):
855
self.test_dir = candidate_dir
856
os.mkdir(self.test_dir)
857
os.chdir(self.test_dir)
859
os.environ['HOME'] = self.test_dir
860
os.environ['APPDATA'] = self.test_dir
861
def _leaveDirectory():
862
os.chdir(_currentdir)
863
self.addCleanup(_leaveDirectory)
1911
For TestCaseInTempDir we create a temporary directory based on the test
1912
name and then create two subdirs - test and home under it.
1914
# create a directory within the top level test directory
1915
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1916
# now create test and home directories within this dir
1917
self.test_base_dir = candidate_dir
1918
self.test_home_dir = self.test_base_dir + '/home'
1919
os.mkdir(self.test_home_dir)
1920
self.test_dir = self.test_base_dir + '/work'
1921
os.mkdir(self.test_dir)
1922
os.chdir(self.test_dir)
1923
# put name of test inside
1924
f = file(self.test_base_dir + '/name', 'w')
1929
self.addCleanup(self.deleteTestDir)
1931
def deleteTestDir(self):
1932
os.chdir(self.TEST_ROOT)
1933
_rmtree_temp_dir(self.test_base_dir)
1935
def build_tree(self, shape, line_endings='binary', transport=None):
865
def build_tree(self, shape, line_endings='native', transport=None):
1936
866
"""Build a test tree according to a pattern.
1938
868
shape is a sequence of file specifications. If the final
1939
869
character is '/', a directory is created.
1941
This assumes that all the elements in the tree being built are new.
1943
871
This doesn't add anything to a branch.
1945
872
:param line_endings: Either 'binary' or 'native'
1946
in binary mode, exact contents are written in native mode, the
1947
line endings match the default platform endings.
1948
:param transport: A transport to write to, for building trees on VFS's.
1949
If the transport is readonly or None, "." is opened automatically.
873
in binary mode, exact contents are written
874
in native mode, the line endings match the
875
default platform endings.
877
:param transport: A transport to write to, for building trees on
878
VFS's. If the transport is readonly or None,
879
"." is opened automatically.
1952
# It's OK to just create them using forward slashes on windows.
881
# XXX: It's OK to just create them using forward slashes on windows?
1953
882
if transport is None or transport.is_readonly():
1954
883
transport = get_transport(".")
1955
884
for name in shape:
1962
891
elif line_endings == 'native':
1963
892
end = os.linesep
1965
raise errors.BzrError(
1966
'Invalid line ending request %r' % line_endings)
894
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1967
895
content = "contents of %s%s" % (name.encode('utf-8'), end)
1968
transport.put_bytes_non_atomic(urlutils.escape(name), content)
896
transport.put(urlutils.escape(name), StringIO(content))
1970
898
def build_tree_contents(self, shape):
1971
899
build_tree_contents(shape)
901
def failUnlessExists(self, path):
902
"""Fail unless path, which may be abs or relative, exists."""
903
self.failUnless(osutils.lexists(path))
905
def failIfExists(self, path):
906
"""Fail if path, which may be abs or relative, exists."""
907
self.failIf(osutils.lexists(path))
1973
909
def assertFileEqual(self, content, path):
1974
910
"""Fail if path does not contain 'content'."""
1975
self.failUnlessExists(path)
1976
f = file(path, 'rb')
1981
self.assertEqualDiff(content, s)
1983
def failUnlessExists(self, path):
1984
"""Fail unless path or paths, which may be abs or relative, exist."""
1985
if not isinstance(path, basestring):
1987
self.failUnlessExists(p)
1989
self.failUnless(osutils.lexists(path),path+" does not exist")
1991
def failIfExists(self, path):
1992
"""Fail if path or paths, which may be abs or relative, exist."""
1993
if not isinstance(path, basestring):
1995
self.failIfExists(p)
1997
self.failIf(osutils.lexists(path),path+" exists")
1999
def assertInWorkingTree(self,path,root_path='.',tree=None):
2000
"""Assert whether path or paths are in the WorkingTree"""
2002
tree = workingtree.WorkingTree.open(root_path)
2003
if not isinstance(path, basestring):
2005
self.assertInWorkingTree(p,tree=tree)
2007
self.assertIsNot(tree.path2id(path), None,
2008
path+' not in working tree.')
2010
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2011
"""Assert whether path or paths are not in the WorkingTree"""
2013
tree = workingtree.WorkingTree.open(root_path)
2014
if not isinstance(path, basestring):
2016
self.assertNotInWorkingTree(p,tree=tree)
2018
self.assertIs(tree.path2id(path), None, path+' in working tree.')
911
self.failUnless(osutils.lexists(path))
912
# TODO: jam 20060427 Shouldn't this be 'rb'?
913
self.assertEqualDiff(content, open(path, 'r').read())
2021
916
class TestCaseWithTransport(TestCaseInTempDir):
2032
927
readwrite one must both define get_url() as resolving to os.getcwd().
2035
def get_vfs_only_server(self):
2036
"""See TestCaseWithMemoryTransport.
930
def __init__(self, methodName='testMethod'):
931
super(TestCaseWithTransport, self).__init__(methodName)
932
self.__readonly_server = None
934
self.transport_server = default_transport
935
self.transport_readonly_server = None
937
def get_readonly_url(self, relpath=None):
938
"""Get a URL for the readonly transport.
940
This will either be backed by '.' or a decorator to the transport
941
used by self.get_url()
942
relpath provides for clients to get a path relative to the base url.
943
These should only be downwards relative, not upwards.
945
base = self.get_readonly_server().get_url()
946
if relpath is not None:
947
if not base.endswith('/'):
949
base = base + relpath
952
def get_readonly_server(self):
953
"""Get the server instance for the readonly transport
955
This is useful for some tests with specific servers to do diagnostics.
957
if self.__readonly_server is None:
958
if self.transport_readonly_server is None:
959
# readonly decorator requested
960
# bring up the server
962
self.__readonly_server = ReadonlyServer()
963
self.__readonly_server.setUp(self.__server)
965
self.__readonly_server = self.transport_readonly_server()
966
self.__readonly_server.setUp()
967
self.addCleanup(self.__readonly_server.tearDown)
968
return self.__readonly_server
970
def get_server(self):
971
"""Get the read/write server instance.
2038
973
This is useful for some tests with specific servers that need
2041
if self.__vfs_server is None:
2042
self.__vfs_server = self.vfs_transport_factory()
2043
self.__vfs_server.setUp()
2044
self.addCleanup(self.__vfs_server.tearDown)
2045
return self.__vfs_server
976
if self.__server is None:
977
self.__server = self.transport_server()
978
self.__server.setUp()
979
self.addCleanup(self.__server.tearDown)
982
def get_url(self, relpath=None):
983
"""Get a URL for the readwrite transport.
985
This will either be backed by '.' or to an equivalent non-file based
987
relpath provides for clients to get a path relative to the base url.
988
These should only be downwards relative, not upwards.
990
base = self.get_server().get_url()
991
if relpath is not None and relpath != '.':
992
if not base.endswith('/'):
994
base = base + urlutils.escape(relpath)
997
def get_transport(self):
998
"""Return a writeable transport for the test scratch space"""
999
t = get_transport(self.get_url())
1000
self.assertFalse(t.is_readonly())
1003
def get_readonly_transport(self):
1004
"""Return a readonly transport for the test scratch space
1006
This can be used to test that operations which should only need
1007
readonly access in fact do not try to write.
1009
t = get_transport(self.get_readonly_url())
1010
self.assertTrue(t.is_readonly())
1013
def make_branch(self, relpath, format=None):
1014
"""Create a branch on the transport at relpath."""
1015
repo = self.make_repository(relpath, format=format)
1016
return repo.bzrdir.create_branch()
1018
def make_bzrdir(self, relpath, format=None):
1020
url = self.get_url(relpath)
1021
mutter('relpath %r => url %r', relpath, url)
1022
segments = url.split('/')
1023
if segments and segments[-1] not in ('', '.'):
1024
parent = '/'.join(segments[:-1])
1025
t = get_transport(parent)
1027
t.mkdir(segments[-1])
1028
except errors.FileExists:
1031
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1032
# FIXME: make this use a single transport someday. RBC 20060418
1033
return format.initialize_on_transport(get_transport(relpath))
1034
except errors.UninitializableFormat:
1035
raise TestSkipped("Format %s is not initializable." % format)
1037
def make_repository(self, relpath, shared=False, format=None):
1038
"""Create a repository on our default transport at relpath."""
1039
made_control = self.make_bzrdir(relpath, format=format)
1040
return made_control.create_repository(shared=shared)
2047
1042
def make_branch_and_tree(self, relpath, format=None):
2048
1043
"""Create a branch on the transport and a tree locally.
2050
If the transport is not a LocalTransport, the Tree can't be created on
2051
the transport. In that case if the vfs_transport_factory is
2052
LocalURLServer the working tree is created in the local
2053
directory backing the transport, and the returned tree's branch and
2054
repository will also be accessed locally. Otherwise a lightweight
2055
checkout is created and returned.
2057
:param format: The BzrDirFormat.
2058
:returns: the WorkingTree.
2060
1047
# TODO: always use the local disk path for the working tree,
2061
1048
# this obviously requires a format that supports branch references
2120
1089
def setUp(self):
2121
1090
super(ChrootedTestCase, self).setUp()
2122
if not self.vfs_transport_factory == MemoryServer:
2123
self.transport_readonly_server = HttpServer
2126
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2127
random_order=False):
2128
"""Create a test suite by filtering another one.
2130
:param suite: the source suite
2131
:param pattern: pattern that names must match
2132
:param exclude_pattern: pattern that names must not match, if any
2133
:param random_order: if True, tests in the new suite will be put in
2135
:returns: the newly created suite
2137
return sort_suite_by_re(suite, pattern, exclude_pattern,
2138
random_order, False)
2141
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2142
random_order=False, append_rest=True):
2143
"""Create a test suite by sorting another one.
2145
:param suite: the source suite
2146
:param pattern: pattern that names must match in order to go
2147
first in the new suite
2148
:param exclude_pattern: pattern that names must not match, if any
2149
:param random_order: if True, tests in the new suite will be put in
2151
:param append_rest: if False, pattern is a strict filter and not
2152
just an ordering directive
2153
:returns: the newly created suite
1091
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1092
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1095
def filter_suite_by_re(suite, pattern):
1096
result = TestSuite()
2157
1097
filter_re = re.compile(pattern)
2158
if exclude_pattern is not None:
2159
exclude_re = re.compile(exclude_pattern)
2160
1098
for test in iter_suite_tests(suite):
2162
if exclude_pattern is None or not exclude_re.search(test_id):
2163
if filter_re.search(test_id):
2168
random.shuffle(first)
2169
random.shuffle(second)
2170
return TestUtil.TestSuite(first + second)
1099
if filter_re.search(test.id()):
1100
result.addTest(test)
2173
1104
def run_suite(suite, name='test', verbose=False, pattern=".*",
2174
stop_on_failure=False,
2175
transport=None, lsprof_timed=None, bench_history=None,
2176
matching_tests_first=None,
2180
exclude_pattern=None,
2182
use_numbered_dirs = bool(numbered_dirs)
1105
stop_on_failure=False, keep_output=False,
1106
transport=None, lsprof_timed=None):
1107
TestCaseInTempDir._TEST_NAME = name
2184
1108
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2185
if numbered_dirs is not None:
2186
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
1114
pb = progress.ProgressBar()
2191
1115
runner = TextTestRunner(stream=sys.stdout,
2192
1116
descriptions=0,
2193
1117
verbosity=verbosity,
2194
bench_history=bench_history,
2195
use_numbered_dirs=use_numbered_dirs,
2196
list_only=list_only,
1118
keep_output=keep_output,
2198
1120
runner.stop_on_failure=stop_on_failure
2199
# Initialise the random number generator and display the seed used.
2200
# We convert the seed to a long to make it reuseable across invocations.
2201
random_order = False
2202
if random_seed is not None:
2204
if random_seed == "now":
2205
random_seed = long(time.time())
2207
# Convert the seed to a long if we can
2209
random_seed = long(random_seed)
2212
runner.stream.writeln("Randomizing test order using seed %s\n" %
2214
random.seed(random_seed)
2215
# Customise the list of tests if requested
2216
if pattern != '.*' or exclude_pattern is not None or random_order:
2217
if matching_tests_first:
2218
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2221
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
1122
suite = filter_suite_by_re(suite, pattern)
2223
1123
result = runner.run(suite)
2224
1124
return result.wasSuccessful()
2227
1127
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2228
1129
transport=None,
2229
1130
test_suite_factory=None,
2232
matching_tests_first=None,
2236
exclude_pattern=None):
2237
1132
"""Run the whole test suite under the enhanced runner"""
2238
# XXX: Very ugly way to do this...
2239
# Disable warning about old formats because we don't want it to disturb
2240
# any blackbox tests.
2241
from bzrlib import repository
2242
repository._deprecation_warning_done = True
2244
1133
global default_transport
2245
1134
if transport is None:
2246
1135
transport = default_transport
2271
1154
This function can be replaced if you need to change the default test
2272
1155
suite on a global basis, but it is not encouraged.
1157
from doctest import DocTestSuite
1159
global MODULES_TO_DOCTEST
2275
1162
'bzrlib.tests.test_ancestry',
2276
'bzrlib.tests.test_annotate',
2277
1163
'bzrlib.tests.test_api',
2278
'bzrlib.tests.test_atomicfile',
2279
1164
'bzrlib.tests.test_bad_files',
2280
1165
'bzrlib.tests.test_branch',
2281
'bzrlib.tests.test_branchbuilder',
2282
'bzrlib.tests.test_bugtracker',
2283
1166
'bzrlib.tests.test_bundle',
2284
1167
'bzrlib.tests.test_bzrdir',
2285
'bzrlib.tests.test_cache_utf8',
2286
'bzrlib.tests.test_commands',
1168
'bzrlib.tests.test_command',
2287
1169
'bzrlib.tests.test_commit',
2288
1170
'bzrlib.tests.test_commit_merge',
2289
1171
'bzrlib.tests.test_config',
2290
1172
'bzrlib.tests.test_conflicts',
2291
'bzrlib.tests.test_pack',
2292
'bzrlib.tests.test_counted_lock',
2293
1173
'bzrlib.tests.test_decorators',
2294
'bzrlib.tests.test_delta',
2295
'bzrlib.tests.test_deprecated_graph',
2296
1174
'bzrlib.tests.test_diff',
2297
'bzrlib.tests.test_dirstate',
1175
'bzrlib.tests.test_doc_generate',
2298
1176
'bzrlib.tests.test_errors',
2299
1177
'bzrlib.tests.test_escaped_store',
2300
'bzrlib.tests.test_extract',
2301
1178
'bzrlib.tests.test_fetch',
2302
'bzrlib.tests.test_ftp_transport',
2303
'bzrlib.tests.test_generate_docs',
2304
'bzrlib.tests.test_generate_ids',
2305
'bzrlib.tests.test_globbing',
2306
1179
'bzrlib.tests.test_gpg',
2307
1180
'bzrlib.tests.test_graph',
2308
1181
'bzrlib.tests.test_hashcache',
2309
'bzrlib.tests.test_help',
2310
'bzrlib.tests.test_hooks',
2311
1182
'bzrlib.tests.test_http',
2312
'bzrlib.tests.test_http_response',
2313
'bzrlib.tests.test_https_ca_bundle',
2314
1183
'bzrlib.tests.test_identitymap',
2315
'bzrlib.tests.test_ignores',
2316
'bzrlib.tests.test_info',
2317
1184
'bzrlib.tests.test_inv',
2318
1185
'bzrlib.tests.test_knit',
2319
'bzrlib.tests.test_lazy_import',
2320
'bzrlib.tests.test_lazy_regex',
2321
1186
'bzrlib.tests.test_lockdir',
2322
1187
'bzrlib.tests.test_lockable_files',
2323
1188
'bzrlib.tests.test_log',
2324
'bzrlib.tests.test_lsprof',
2325
'bzrlib.tests.test_memorytree',
2326
1189
'bzrlib.tests.test_merge',
2327
1190
'bzrlib.tests.test_merge3',
2328
1191
'bzrlib.tests.test_merge_core',
2329
'bzrlib.tests.test_merge_directive',
2330
1192
'bzrlib.tests.test_missing',
2331
1193
'bzrlib.tests.test_msgeditor',
2332
1194
'bzrlib.tests.test_nonascii',
2333
1195
'bzrlib.tests.test_options',
2334
1196
'bzrlib.tests.test_osutils',
2335
'bzrlib.tests.test_osutils_encodings',
2336
1197
'bzrlib.tests.test_patch',
2337
1198
'bzrlib.tests.test_patches',
2338
1199
'bzrlib.tests.test_permissions',
2339
1200
'bzrlib.tests.test_plugins',
2340
1201
'bzrlib.tests.test_progress',
2341
1202
'bzrlib.tests.test_reconcile',
2342
'bzrlib.tests.test_registry',
2343
'bzrlib.tests.test_remote',
2344
1203
'bzrlib.tests.test_repository',
2345
'bzrlib.tests.test_revert',
2346
1204
'bzrlib.tests.test_revision',
2347
1205
'bzrlib.tests.test_revisionnamespaces',
2348
'bzrlib.tests.test_revisiontree',
1206
'bzrlib.tests.test_revprops',
2349
1207
'bzrlib.tests.test_rio',
2350
1208
'bzrlib.tests.test_sampler',
2351
1209
'bzrlib.tests.test_selftest',
2352
1210
'bzrlib.tests.test_setup',
2353
1211
'bzrlib.tests.test_sftp_transport',
2354
'bzrlib.tests.test_smart',
2355
1212
'bzrlib.tests.test_smart_add',
2356
'bzrlib.tests.test_smart_transport',
2357
'bzrlib.tests.test_smtp_connection',
2358
1213
'bzrlib.tests.test_source',
2359
'bzrlib.tests.test_ssh_transport',
2360
1214
'bzrlib.tests.test_status',
2361
1215
'bzrlib.tests.test_store',
2362
'bzrlib.tests.test_strace',
2363
'bzrlib.tests.test_subsume',
2364
1216
'bzrlib.tests.test_symbol_versioning',
2365
'bzrlib.tests.test_tag',
2366
1217
'bzrlib.tests.test_testament',
2367
1218
'bzrlib.tests.test_textfile',
2368
1219
'bzrlib.tests.test_textmerge',
2369
'bzrlib.tests.test_timestamp',
2370
1220
'bzrlib.tests.test_trace',
2371
1221
'bzrlib.tests.test_transactions',
2372
1222
'bzrlib.tests.test_transform',
2373
1223
'bzrlib.tests.test_transport',
2374
'bzrlib.tests.test_tree',
2375
'bzrlib.tests.test_treebuilder',
2376
1224
'bzrlib.tests.test_tsort',
2377
1225
'bzrlib.tests.test_tuned_gzip',
2378
1226
'bzrlib.tests.test_ui',
2379
1227
'bzrlib.tests.test_upgrade',
2380
1228
'bzrlib.tests.test_urlutils',
2381
1229
'bzrlib.tests.test_versionedfile',
2382
'bzrlib.tests.test_version',
2383
'bzrlib.tests.test_version_info',
2384
1230
'bzrlib.tests.test_weave',
2385
1231
'bzrlib.tests.test_whitebox',
2386
1232
'bzrlib.tests.test_workingtree',
2387
'bzrlib.tests.test_workingtree_4',
2388
'bzrlib.tests.test_wsgi',
2389
1233
'bzrlib.tests.test_xml',
2391
1235
test_transport_implementations = [
2392
'bzrlib.tests.test_transport_implementations',
2393
'bzrlib.tests.test_read_bundle',
2395
suite = TestUtil.TestSuite()
1236
'bzrlib.tests.test_transport_implementations']
2396
1239
loader = TestUtil.TestLoader()
2397
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2398
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
1240
from bzrlib.transport import TransportTestProviderAdapter
2399
1241
adapter = TransportTestProviderAdapter()
2400
1242
adapt_modules(test_transport_implementations, adapter, loader, suite)
1243
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2401
1244
for package in packages_to_test():
2402
1245
suite.addTest(package.test_suite())
2403
1246
for m in MODULES_TO_TEST:
2404
1247
suite.addTest(loader.loadTestsFromModule(m))
2405
for m in MODULES_TO_DOCTEST:
2407
suite.addTest(doctest.DocTestSuite(m))
2408
except ValueError, e:
2409
print '**failed to get doctest for: %s\n%s' %(m,e)
1248
for m in (MODULES_TO_DOCTEST):
1249
suite.addTest(DocTestSuite(m))
2411
1250
for name, plugin in bzrlib.plugin.all_plugins().items():
2412
1251
if getattr(plugin, 'test_suite', None) is not None:
2413
default_encoding = sys.getdefaultencoding()
2415
plugin_suite = plugin.test_suite()
2416
except ImportError, e:
2417
bzrlib.trace.warning(
2418
'Unable to test plugin "%s": %s', name, e)
2420
suite.addTest(plugin_suite)
2421
if default_encoding != sys.getdefaultencoding():
2422
bzrlib.trace.warning(
2423
'Plugin "%s" tried to reset default encoding to: %s', name,
2424
sys.getdefaultencoding())
2426
sys.setdefaultencoding(default_encoding)
1252
suite.addTest(plugin.test_suite())
2431
1257
"""Adapt the modules in mods_list using adapter and add to suite."""
2432
1258
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2433
1259
suite.addTests(adapter.adapt(test))
2436
def _rmtree_temp_dir(dirname):
2437
# If LANG=C we probably have created some bogus paths
2438
# which rmtree(unicode) will fail to delete
2439
# so make sure we are using rmtree(str) to delete everything
2440
# except on win32, where rmtree(str) will fail
2441
# since it doesn't have the property of byte-stream paths
2442
# (they are either ascii or mbcs)
2443
if sys.platform == 'win32':
2444
# make sure we are using the unicode win32 api
2445
dirname = unicode(dirname)
2447
dirname = dirname.encode(sys.getfilesystemencoding())
2449
osutils.rmtree(dirname)
2451
if sys.platform == 'win32' and e.errno == errno.EACCES:
2452
print >>sys.stderr, ('Permission denied: '
2453
'unable to remove testing dir '
2454
'%s' % os.path.basename(dirname))
2459
def clean_selftest_output(root=None, quiet=False):
2460
"""Remove all selftest output directories from root directory.
2462
:param root: root directory for clean
2463
(if ommitted or None then clean current directory).
2464
:param quiet: suppress report about deleting directories
2467
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2470
for i in os.listdir(root):
2471
if os.path.isdir(i) and re_dir.match(i):
2473
print 'delete directory:', i
2477
class Feature(object):
2478
"""An operating system Feature."""
2481
self._available = None
2483
def available(self):
2484
"""Is the feature available?
2486
:return: True if the feature is available.
2488
if self._available is None:
2489
self._available = self._probe()
2490
return self._available
2493
"""Implement this method in concrete features.
2495
:return: True if the feature is available.
2497
raise NotImplementedError
2500
if getattr(self, 'feature_name', None):
2501
return self.feature_name()
2502
return self.__class__.__name__
2505
class TestScenarioApplier(object):
2506
"""A tool to apply scenarios to tests."""
2508
def adapt(self, test):
2509
"""Return a TestSuite containing a copy of test for each scenario."""
2510
result = unittest.TestSuite()
2511
for scenario in self.scenarios:
2512
result.addTest(self.adapt_test_to_scenario(test, scenario))
2515
def adapt_test_to_scenario(self, test, scenario):
2516
"""Copy test and apply scenario to it.
2518
:param test: A test to adapt.
2519
:param scenario: A tuple describing the scenarion.
2520
The first element of the tuple is the new test id.
2521
The second element is a dict containing attributes to set on the
2523
:return: The adapted test.
2525
from copy import deepcopy
2526
new_test = deepcopy(test)
2527
for name, value in scenario[1].items():
2528
setattr(new_test, name, value)
2529
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2530
new_test.id = lambda: new_id
added
removed
bzrlib/tests/__init__.py
