59
75
from bzrlib.merge import merge_inner
60
76
import bzrlib.merge3
62
import bzrlib.osutils as osutils
63
77
import bzrlib.plugin
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
66
78
import bzrlib.store
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
67
86
import bzrlib.trace
68
87
from bzrlib.transport import get_transport
69
88
import bzrlib.transport
70
from bzrlib.transport.local import LocalRelpathServer
89
from bzrlib.transport.local import LocalURLServer
90
from bzrlib.transport.memory import MemoryServer
71
91
from bzrlib.transport.readonly import ReadonlyServer
72
from bzrlib.trace import mutter
92
from bzrlib.trace import mutter, note
73
93
from bzrlib.tests import TestUtil
94
from bzrlib.tests.http_server import HttpServer
74
95
from bzrlib.tests.TestUtil import (
78
99
from bzrlib.tests.treeshape import build_tree_contents
79
import bzrlib.urlutils as urlutils
100
import bzrlib.version_info_formats.format_custom
80
101
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
82
default_transport = LocalRelpathServer
85
MODULES_TO_DOCTEST = [
87
bzrlib.bundle.serializer,
100
def packages_to_test():
101
"""Return a list of packages to test.
103
The packages are not globally imported so that import failures are
104
triggered when running selftest, not when importing the command.
107
import bzrlib.tests.blackbox
108
import bzrlib.tests.branch_implementations
109
import bzrlib.tests.bzrdir_implementations
110
import bzrlib.tests.interrepository_implementations
111
import bzrlib.tests.interversionedfile_implementations
112
import bzrlib.tests.repository_implementations
113
import bzrlib.tests.revisionstore_implementations
114
import bzrlib.tests.workingtree_implementations
117
bzrlib.tests.blackbox,
118
bzrlib.tests.branch_implementations,
119
bzrlib.tests.bzrdir_implementations,
120
bzrlib.tests.interrepository_implementations,
121
bzrlib.tests.interversionedfile_implementations,
122
bzrlib.tests.repository_implementations,
123
bzrlib.tests.revisionstore_implementations,
124
bzrlib.tests.workingtree_implementations,
128
class _MyResult(unittest._TextTestResult):
129
"""Custom TestResult.
131
Shows output in a different format, including displaying runtime for tests.
103
# Mark this python module as being part of the implementation
104
# of unittest: this gives us better tracebacks where the last
105
# shown frame is the test code, not our assertXYZ.
108
default_transport = LocalURLServer
111
class ExtendedTestResult(unittest._TextTestResult):
112
"""Accepts, reports and accumulates the results of running tests.
114
Compared to the unittest version this class adds support for
115
profiling, benchmarking, stopping as soon as a test fails, and
116
skipping tests. There are further-specialized subclasses for
117
different types of display.
119
When a test finishes, in whatever way, it calls one of the addSuccess,
120
addFailure or addError classes. These in turn may redirect to a more
121
specific case for the special test results supported by our extended
124
Note that just one of these objects is fed the results from many tests.
133
127
stop_early = False
135
def __init__(self, stream, descriptions, verbosity, pb=None):
129
def __init__(self, stream, descriptions, verbosity,
133
"""Construct new TestResult.
135
:param bench_history: Optionally, a writable file object to accumulate
136
138
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
139
if bench_history is not None:
140
from bzrlib.version import _get_bzr_source_tree
141
src_tree = _get_bzr_source_tree()
144
revision_id = src_tree.get_parent_ids()[0]
146
# XXX: if this is a brand new tree, do the same as if there
150
# XXX: If there's no branch, what should we do?
152
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
153
self._bench_history = bench_history
154
self.ui = ui.ui_factory
155
self.num_tests = num_tests
157
self.failure_count = 0
158
self.known_failure_count = 0
160
self.not_applicable_count = 0
161
self.unsupported = {}
163
self._overall_start_time = time.time()
139
def extractBenchmarkTime(self, testCase):
165
def _extractBenchmarkTime(self, testCase):
140
166
"""Add a benchmark time for the current test case."""
141
self._benchmarkTime = getattr(testCase, "_benchtime", None)
167
return getattr(testCase, "_benchtime", None)
143
169
def _elapsedTestTimeString(self):
144
170
"""Return a time string for the overall time the current test has taken."""
145
171
return self._formatTime(time.time() - self._start_time)
147
def _testTimeString(self):
148
if self._benchmarkTime is not None:
173
def _testTimeString(self, testCase):
174
benchmark_time = self._extractBenchmarkTime(testCase)
175
if benchmark_time is not None:
149
176
return "%s/%s" % (
150
self._formatTime(self._benchmarkTime),
177
self._formatTime(benchmark_time),
151
178
self._elapsedTestTimeString())
153
return " %s" % self._elapsedTestTimeString()
180
return " %s" % self._elapsedTestTimeString()
155
182
def _formatTime(self, seconds):
156
183
"""Format seconds as milliseconds with leading spaces."""
157
return "%5dms" % (1000 * seconds)
184
# some benchmarks can take thousands of seconds to run, so we need 8
186
return "%8dms" % (1000 * seconds)
159
def _ellipsise_unimportant_words(self, a_string, final_width,
161
"""Add ellipses (sp?) for overly long strings.
163
:param keep_start: If true preserve the start of a_string rather
167
if len(a_string) > final_width:
168
result = a_string[:final_width-3] + '...'
172
if len(a_string) > final_width:
173
result = '...' + a_string[3-final_width:]
176
return result.ljust(final_width)
188
def _shortened_test_description(self, test):
190
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
178
193
def startTest(self, test):
179
194
unittest.TestResult.startTest(self, test)
180
# In a short description, the important words are in
181
# the beginning, but in an id, the important words are
183
SHOW_DESCRIPTIONS = False
185
if not self.showAll and self.dots and self.pb is not None:
188
final_width = osutils.terminal_width()
189
final_width = final_width - 15 - 8
191
if SHOW_DESCRIPTIONS:
192
what = test.shortDescription()
194
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
197
if what.startswith('bzrlib.tests.'):
199
what = self._ellipsise_unimportant_words(what, final_width)
201
self.stream.write(what)
202
elif self.dots and self.pb is not None:
203
self.pb.update(what, self.testsRun - 1, None)
195
self.report_test_start(test)
196
test.number = self.count
205
197
self._recordTestStartTime()
207
199
def _recordTestStartTime(self):
208
200
"""Record that a test has started."""
209
201
self._start_time = time.time()
203
def _cleanupLogFile(self, test):
204
# We can only do this if we have one of our TestCases, not if
206
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
207
if setKeepLogfile is not None:
211
210
def addError(self, test, err):
211
"""Tell result that test finished with an error.
213
Called from the TestCase run() method when the test
214
fails with an unexpected error.
216
self._testConcluded(test)
212
217
if isinstance(err[1], TestSkipped):
213
return self.addSkipped(test, err)
214
unittest.TestResult.addError(self, test, err)
215
self.extractBenchmarkTime(test)
217
self.stream.writeln("ERROR %s" % self._testTimeString())
218
elif self.dots and self.pb is None:
219
self.stream.write('E')
221
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
218
return self._addSkipped(test, err)
219
elif isinstance(err[1], UnavailableFeature):
220
return self.addNotSupported(test, err[1].args[0])
222
unittest.TestResult.addError(self, test, err)
223
self.error_count += 1
224
self.report_error(test, err)
227
self._cleanupLogFile(test)
226
229
def addFailure(self, test, err):
227
unittest.TestResult.addFailure(self, test, err)
228
self.extractBenchmarkTime(test)
230
self.stream.writeln(" FAIL %s" % self._testTimeString())
231
elif self.dots and self.pb is None:
232
self.stream.write('F')
234
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
230
"""Tell result that test failed.
232
Called from the TestCase run() method when the test
233
fails because e.g. an assert() method failed.
235
self._testConcluded(test)
236
if isinstance(err[1], KnownFailure):
237
return self._addKnownFailure(test, err)
239
unittest.TestResult.addFailure(self, test, err)
240
self.failure_count += 1
241
self.report_failure(test, err)
244
self._cleanupLogFile(test)
239
246
def addSuccess(self, test):
240
self.extractBenchmarkTime(test)
242
self.stream.writeln(' OK %s' % self._testTimeString())
243
for bench_called, stats in getattr(test, '_benchcalls', []):
244
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
245
stats.pprint(file=self.stream)
246
elif self.dots and self.pb is None:
247
self.stream.write('~')
249
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
247
"""Tell result that test completed successfully.
249
Called from the TestCase run()
251
self._testConcluded(test)
252
if self._bench_history is not None:
253
benchmark_time = self._extractBenchmarkTime(test)
254
if benchmark_time is not None:
255
self._bench_history.write("%s %s\n" % (
256
self._formatTime(benchmark_time),
258
self.report_success(test)
259
self._cleanupLogFile(test)
251
260
unittest.TestResult.addSuccess(self, test)
253
def addSkipped(self, test, skip_excinfo):
254
self.extractBenchmarkTime(test)
256
print >>self.stream, ' SKIP %s' % self._testTimeString()
257
print >>self.stream, ' %s' % skip_excinfo[1]
258
elif self.dots and self.pb is None:
259
self.stream.write('S')
261
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
263
# seems best to treat this as success from point-of-view of unittest
264
# -- it actually does nothing so it barely matters :)
261
test._log_contents = ''
263
def _testConcluded(self, test):
264
"""Common code when a test has finished.
266
Called regardless of whether it succeded, failed, etc.
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
"""The test will not be run because of a missing feature.
277
# this can be called in two different ways: it may be that the
278
# test started running, and then raised (through addError)
279
# UnavailableFeature. Alternatively this method can be called
280
# while probing for features before running the tests; in that
281
# case we will see startTest and stopTest, but the test will never
283
self.unsupported.setdefault(str(feature), 0)
284
self.unsupported[str(feature)] += 1
285
self.report_unsupported(test, feature)
287
def _addSkipped(self, test, skip_excinfo):
288
if isinstance(skip_excinfo[1], TestNotApplicable):
289
self.not_applicable_count += 1
290
self.report_not_applicable(test, skip_excinfo)
293
self.report_skip(test, skip_excinfo)
267
296
except KeyboardInterrupt:
270
self.addError(test, test.__exc_info())
299
self.addError(test, test._exc_info())
301
# seems best to treat this as success from point-of-view of unittest
302
# -- it actually does nothing so it barely matters :)
272
303
unittest.TestResult.addSuccess(self, test)
304
test._log_contents = ''
274
306
def printErrorList(self, flavour, errors):
275
307
for test, err in errors:
276
308
self.stream.writeln(self.separator1)
277
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
309
self.stream.write("%s: " % flavour)
310
self.stream.writeln(self.getDescription(test))
278
311
if getattr(test, '_get_log', None) is not None:
280
print >>self.stream, \
281
('vvvv[log from %s]' % test.id()).ljust(78,'-')
282
print >>self.stream, test._get_log()
283
print >>self.stream, \
284
('^^^^[log from %s]' % test.id()).ljust(78,'-')
312
self.stream.write('\n')
314
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
315
self.stream.write('\n')
316
self.stream.write(test._get_log())
317
self.stream.write('\n')
319
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
285
321
self.stream.writeln(self.separator2)
286
322
self.stream.writeln("%s" % err)
327
def report_cleaning_up(self):
330
def report_success(self, test):
333
def wasStrictlySuccessful(self):
334
if self.unsupported or self.known_failure_count:
336
return self.wasSuccessful()
339
class TextTestResult(ExtendedTestResult):
340
"""Displays progress and results of tests in text form"""
342
def __init__(self, stream, descriptions, verbosity,
347
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
348
bench_history, num_tests)
350
self.pb = self.ui.nested_progress_bar()
351
self._supplied_pb = False
354
self._supplied_pb = True
355
self.pb.show_pct = False
356
self.pb.show_spinner = False
357
self.pb.show_eta = False,
358
self.pb.show_count = False
359
self.pb.show_bar = False
361
def report_starting(self):
362
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
364
def _progress_prefix_text(self):
365
# the longer this text, the less space we have to show the test
367
a = '[%d' % self.count # total that have been run
368
# tests skipped as known not to be relevant are not important enough
370
## if self.skip_count:
371
## a += ', %d skip' % self.skip_count
372
## if self.known_failure_count:
373
## a += '+%dX' % self.known_failure_count
374
if self.num_tests is not None:
375
a +='/%d' % self.num_tests
377
runtime = time.time() - self._overall_start_time
379
a += '%dm%ds' % (runtime / 60, runtime % 60)
383
a += ', %d err' % self.error_count
384
if self.failure_count:
385
a += ', %d fail' % self.failure_count
387
a += ', %d missing' % len(self.unsupported)
391
def report_test_start(self, test):
394
self._progress_prefix_text()
396
+ self._shortened_test_description(test))
398
def _test_description(self, test):
399
return self._shortened_test_description(test)
401
def report_error(self, test, err):
402
self.pb.note('ERROR: %s\n %s\n',
403
self._test_description(test),
407
def report_failure(self, test, err):
408
self.pb.note('FAIL: %s\n %s\n',
409
self._test_description(test),
413
def report_known_failure(self, test, err):
414
self.pb.note('XFAIL: %s\n%s\n',
415
self._test_description(test), err[1])
417
def report_skip(self, test, skip_excinfo):
420
def report_not_applicable(self, test, skip_excinfo):
423
def report_unsupported(self, test, feature):
424
"""test cannot be run because feature is missing."""
426
def report_cleaning_up(self):
427
self.pb.update('cleaning up...')
430
if not self._supplied_pb:
434
class VerboseTestResult(ExtendedTestResult):
435
"""Produce long output, with one line per test run plus times"""
437
def _ellipsize_to_right(self, a_string, final_width):
438
"""Truncate and pad a string, keeping the right hand side"""
439
if len(a_string) > final_width:
440
result = '...' + a_string[3-final_width:]
443
return result.ljust(final_width)
445
def report_starting(self):
446
self.stream.write('running %d tests...\n' % self.num_tests)
448
def report_test_start(self, test):
450
name = self._shortened_test_description(test)
451
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
452
# numbers, plus a trailing blank
453
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
454
self.stream.write(self._ellipsize_to_right(name,
455
osutils.terminal_width()-30))
458
def _error_summary(self, err):
460
return '%s%s' % (indent, err[1])
462
def report_error(self, test, err):
463
self.stream.writeln('ERROR %s\n%s'
464
% (self._testTimeString(test),
465
self._error_summary(err)))
467
def report_failure(self, test, err):
468
self.stream.writeln(' FAIL %s\n%s'
469
% (self._testTimeString(test),
470
self._error_summary(err)))
472
def report_known_failure(self, test, err):
473
self.stream.writeln('XFAIL %s\n%s'
474
% (self._testTimeString(test),
475
self._error_summary(err)))
477
def report_success(self, test):
478
self.stream.writeln(' OK %s' % self._testTimeString(test))
479
for bench_called, stats in getattr(test, '_benchcalls', []):
480
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
481
stats.pprint(file=self.stream)
482
# flush the stream so that we get smooth output. This verbose mode is
483
# used to show the output in PQM.
486
def report_skip(self, test, skip_excinfo):
487
self.stream.writeln(' SKIP %s\n%s'
488
% (self._testTimeString(test),
489
self._error_summary(skip_excinfo)))
491
def report_not_applicable(self, test, skip_excinfo):
492
self.stream.writeln(' N/A %s\n%s'
493
% (self._testTimeString(test),
494
self._error_summary(skip_excinfo)))
496
def report_unsupported(self, test, feature):
497
"""test cannot be run because feature is missing."""
498
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
499
%(self._testTimeString(test), feature))
289
502
class TextTestRunner(object):
290
503
stop_on_failure = False
536
981
self.assertEqual(mode, actual_mode,
537
982
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
984
def assertIsSameRealPath(self, path1, path2):
985
"""Fail if path1 and path2 points to different files"""
986
self.assertEqual(osutils.realpath(path1),
987
osutils.realpath(path2),
988
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
539
990
def assertIsInstance(self, obj, kls):
540
991
"""Fail if obj is not an instance of kls"""
541
992
if not isinstance(obj, kls):
542
993
self.fail("%r is an instance of %s rather than %s" % (
543
994
obj, obj.__class__, kls))
996
def expectFailure(self, reason, assertion, *args, **kwargs):
997
"""Invoke a test, expecting it to fail for the given reason.
999
This is for assertions that ought to succeed, but currently fail.
1000
(The failure is *expected* but not *wanted*.) Please be very precise
1001
about the failure you're expecting. If a new bug is introduced,
1002
AssertionError should be raised, not KnownFailure.
1004
Frequently, expectFailure should be followed by an opposite assertion.
1007
Intended to be used with a callable that raises AssertionError as the
1008
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1010
Raises KnownFailure if the test fails. Raises AssertionError if the
1015
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1017
self.assertEqual(42, dynamic_val)
1019
This means that a dynamic_val of 54 will cause the test to raise
1020
a KnownFailure. Once math is fixed and the expectFailure is removed,
1021
only a dynamic_val of 42 will allow the test to pass. Anything other
1022
than 54 or 42 will cause an AssertionError.
1025
assertion(*args, **kwargs)
1026
except AssertionError:
1027
raise KnownFailure(reason)
1029
self.fail('Unexpected success. Should have failed: %s' % reason)
1031
def assertFileEqual(self, content, path):
1032
"""Fail if path does not contain 'content'."""
1033
self.failUnlessExists(path)
1034
f = file(path, 'rb')
1039
self.assertEqualDiff(content, s)
1041
def failUnlessExists(self, path):
1042
"""Fail unless path or paths, which may be abs or relative, exist."""
1043
if not isinstance(path, basestring):
1045
self.failUnlessExists(p)
1047
self.failUnless(osutils.lexists(path),path+" does not exist")
1049
def failIfExists(self, path):
1050
"""Fail if path or paths, which may be abs or relative, exist."""
1051
if not isinstance(path, basestring):
1053
self.failIfExists(p)
1055
self.failIf(osutils.lexists(path),path+" exists")
1057
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1058
"""A helper for callDeprecated and applyDeprecated.
1060
:param a_callable: A callable to call.
1061
:param args: The positional arguments for the callable
1062
:param kwargs: The keyword arguments for the callable
1063
:return: A tuple (warnings, result). result is the result of calling
1064
a_callable(``*args``, ``**kwargs``).
1067
def capture_warnings(msg, cls=None, stacklevel=None):
1068
# we've hooked into a deprecation specific callpath,
1069
# only deprecations should getting sent via it.
1070
self.assertEqual(cls, DeprecationWarning)
1071
local_warnings.append(msg)
1072
original_warning_method = symbol_versioning.warn
1073
symbol_versioning.set_warning_method(capture_warnings)
1075
result = a_callable(*args, **kwargs)
1077
symbol_versioning.set_warning_method(original_warning_method)
1078
return (local_warnings, result)
1080
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1081
"""Call a deprecated callable without warning the user.
1083
Note that this only captures warnings raised by symbol_versioning.warn,
1084
not other callers that go direct to the warning module.
1086
To test that a deprecated method raises an error, do something like
1089
self.assertRaises(errors.ReservedId,
1090
self.applyDeprecated,
1091
deprecated_in((1, 5, 0)),
1095
:param deprecation_format: The deprecation format that the callable
1096
should have been deprecated with. This is the same type as the
1097
parameter to deprecated_method/deprecated_function. If the
1098
callable is not deprecated with this format, an assertion error
1100
:param a_callable: A callable to call. This may be a bound method or
1101
a regular function. It will be called with ``*args`` and
1103
:param args: The positional arguments for the callable
1104
:param kwargs: The keyword arguments for the callable
1105
:return: The result of a_callable(``*args``, ``**kwargs``)
1107
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1109
expected_first_warning = symbol_versioning.deprecation_string(
1110
a_callable, deprecation_format)
1111
if len(call_warnings) == 0:
1112
self.fail("No deprecation warning generated by call to %s" %
1114
self.assertEqual(expected_first_warning, call_warnings[0])
1117
def callCatchWarnings(self, fn, *args, **kw):
1118
"""Call a callable that raises python warnings.
1120
The caller's responsible for examining the returned warnings.
1122
If the callable raises an exception, the exception is not
1123
caught and propagates up to the caller. In that case, the list
1124
of warnings is not available.
1126
:returns: ([warning_object, ...], fn_result)
1128
# XXX: This is not perfect, because it completely overrides the
1129
# warnings filters, and some code may depend on suppressing particular
1130
# warnings. It's the easiest way to insulate ourselves from -Werror,
1131
# though. -- Andrew, 20071062
1133
def _catcher(message, category, filename, lineno, file=None):
1134
# despite the name, 'message' is normally(?) a Warning subclass
1136
wlist.append(message)
1137
saved_showwarning = warnings.showwarning
1138
saved_filters = warnings.filters
1140
warnings.showwarning = _catcher
1141
warnings.filters = []
1142
result = fn(*args, **kw)
1144
warnings.showwarning = saved_showwarning
1145
warnings.filters = saved_filters
1146
return wlist, result
1148
def callDeprecated(self, expected, callable, *args, **kwargs):
1149
"""Assert that a callable is deprecated in a particular way.
1151
This is a very precise test for unusual requirements. The
1152
applyDeprecated helper function is probably more suited for most tests
1153
as it allows you to simply specify the deprecation format being used
1154
and will ensure that that is issued for the function being called.
1156
Note that this only captures warnings raised by symbol_versioning.warn,
1157
not other callers that go direct to the warning module. To catch
1158
general warnings, use callCatchWarnings.
1160
:param expected: a list of the deprecation warnings expected, in order
1161
:param callable: The callable to call
1162
:param args: The positional arguments for the callable
1163
:param kwargs: The keyword arguments for the callable
1165
call_warnings, result = self._capture_deprecation_warnings(callable,
1167
self.assertEqual(expected, call_warnings)
545
1170
def _startLogFile(self):
546
1171
"""Send bzr and test log messages to a temporary file.
548
1173
The file is removed as the test is torn down.
550
1175
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
551
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
552
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
553
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1176
self._log_file = os.fdopen(fileno, 'w+')
1177
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
554
1178
self._log_file_name = name
555
1179
self.addCleanup(self._finishLogFile)
557
1181
def _finishLogFile(self):
558
1182
"""Finished with the log file.
560
Read contents into memory, close, and delete.
1184
Close the file and delete it, unless setKeepLogfile was called.
562
1186
if self._log_file is None:
564
bzrlib.trace.disable_test_log(self._log_nonce)
565
self._log_file.seek(0)
566
self._log_contents = self._log_file.read()
1188
bzrlib.trace.pop_log_file(self._log_memento)
567
1189
self._log_file.close()
568
os.remove(self._log_file_name)
569
self._log_file = self._log_file_name = None
571
def addCleanup(self, callable):
1190
self._log_file = None
1191
if not self._keep_log_file:
1192
os.remove(self._log_file_name)
1193
self._log_file_name = None
1195
def setKeepLogfile(self):
1196
"""Make the logfile not be deleted when _finishLogFile is called."""
1197
self._keep_log_file = True
1199
def addCleanup(self, callable, *args, **kwargs):
572
1200
"""Arrange to run a callable when this case is torn down.
574
1202
Callables are run in the reverse of the order they are registered,
575
1203
ie last-in first-out.
577
if callable in self._cleanups:
578
raise ValueError("cleanup function %r already registered on %s"
580
self._cleanups.append(callable)
1205
self._cleanups.append((callable, args, kwargs))
582
1207
def _cleanEnvironment(self):
1209
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
584
1210
'HOME': os.getcwd(),
585
'APPDATA': os.getcwd(),
1211
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1212
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1214
'BZREMAIL': None, # may still be present in the environment
1216
'BZR_PROGRESS_BAR': None,
1219
'SSH_AUTH_SOCK': None,
1223
'https_proxy': None,
1224
'HTTPS_PROXY': None,
1229
# Nobody cares about these ones AFAIK. So far at
1230
# least. If you do (care), please update this comment
1234
'BZR_REMOTE_PATH': None,
589
1236
self.__old_env = {}
590
1237
self.addCleanup(self._restoreEnvironment)
591
1238
for name, value in new_env.iteritems():
592
1239
self._captureVar(name, value)
595
1241
def _captureVar(self, name, newvalue):
596
"""Set an environment variable, preparing it to be reset when finished."""
597
self.__old_env[name] = os.environ.get(name, None)
599
if name in os.environ:
602
os.environ[name] = newvalue
1242
"""Set an environment variable, and reset it when finished."""
1243
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
605
def _restoreVar(name, value):
607
if name in os.environ:
610
os.environ[name] = value
1245
def _restore_debug_flags(self):
1246
debug.debug_flags.clear()
1247
debug.debug_flags.update(self._preserved_debug_flags)
612
1249
def _restoreEnvironment(self):
613
1250
for name, value in self.__old_env.iteritems():
614
self._restoreVar(name, value)
1251
osutils.set_or_unset_env(name, value)
1253
def _restoreHooks(self):
1254
for klass, hooks in self._preserved_hooks.items():
1255
setattr(klass, 'hooks', hooks)
1257
def knownFailure(self, reason):
1258
"""This test has failed for some known reason."""
1259
raise KnownFailure(reason)
1261
def run(self, result=None):
1262
if result is None: result = self.defaultTestResult()
1263
for feature in getattr(self, '_test_needs_features', []):
1264
if not feature.available():
1265
result.startTest(self)
1266
if getattr(result, 'addNotSupported', None):
1267
result.addNotSupported(self, feature)
1269
result.addSuccess(self)
1270
result.stopTest(self)
1273
return unittest.TestCase.run(self, result)
1276
absent_attr = object()
1277
for attr_name in self.attrs_to_keep:
1278
attr = getattr(self, attr_name, absent_attr)
1279
if attr is not absent_attr:
1280
saved_attrs[attr_name] = attr
1281
self.__dict__ = saved_attrs
616
1283
def tearDown(self):
617
1284
self._runCleanups()
853
1700
sys.stderr = real_stderr
854
1701
sys.stdin = real_stdin
856
def merge(self, branch_from, wt_to):
857
"""A helper for tests to do a ui-less merge.
859
This should move to the main library when someone has time to integrate
862
# minimal ui-less merge.
863
wt_to.branch.fetch(branch_from)
864
base_rev = common_ancestor(branch_from.last_revision(),
865
wt_to.branch.last_revision(),
866
wt_to.branch.repository)
867
merge_inner(wt_to.branch, branch_from.basis_tree(),
868
wt_to.branch.repository.revision_tree(base_rev),
870
wt_to.add_pending_merge(branch_from.last_revision())
873
BzrTestBase = TestCase
1703
def reduceLockdirTimeout(self):
1704
"""Reduce the default lock timeout for the duration of the test, so that
1705
if LockContention occurs during a test, it does so quickly.
1707
Tests that expect to provoke LockContention errors should call this.
1709
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1711
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1712
self.addCleanup(resetTimeout)
1713
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1715
def make_utf8_encoded_stringio(self, encoding_type=None):
1716
"""Return a StringIOWrapper instance, that will encode Unicode
1719
if encoding_type is None:
1720
encoding_type = 'strict'
1722
output_encoding = 'utf-8'
1723
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1724
sio.encoding = output_encoding
1728
class TestCaseWithMemoryTransport(TestCase):
1729
"""Common test class for tests that do not need disk resources.
1731
Tests that need disk resources should derive from TestCaseWithTransport.
1733
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1735
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1736
a directory which does not exist. This serves to help ensure test isolation
1737
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1738
must exist. However, TestCaseWithMemoryTransport does not offer local
1739
file defaults for the transport in tests, nor does it obey the command line
1740
override, so tests that accidentally write to the common directory should
1743
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1744
a .bzr directory that stops us ascending higher into the filesystem.
1750
def __init__(self, methodName='runTest'):
1751
# allow test parameterization after test construction and before test
1752
# execution. Variables that the parameterizer sets need to be
1753
# ones that are not set by setUp, or setUp will trash them.
1754
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1755
self.vfs_transport_factory = default_transport
1756
self.transport_server = None
1757
self.transport_readonly_server = None
1758
self.__vfs_server = None
1760
def get_transport(self, relpath=None):
1761
"""Return a writeable transport.
1763
This transport is for the test scratch space relative to
1766
:param relpath: a path relative to the base url.
1768
t = get_transport(self.get_url(relpath))
1769
self.assertFalse(t.is_readonly())
1772
def get_readonly_transport(self, relpath=None):
1773
"""Return a readonly transport for the test scratch space
1775
This can be used to test that operations which should only need
1776
readonly access in fact do not try to write.
1778
:param relpath: a path relative to the base url.
1780
t = get_transport(self.get_readonly_url(relpath))
1781
self.assertTrue(t.is_readonly())
1784
def create_transport_readonly_server(self):
1785
"""Create a transport server from class defined at init.
1787
This is mostly a hook for daughter classes.
1789
return self.transport_readonly_server()
1791
def get_readonly_server(self):
1792
"""Get the server instance for the readonly transport
1794
This is useful for some tests with specific servers to do diagnostics.
1796
if self.__readonly_server is None:
1797
if self.transport_readonly_server is None:
1798
# readonly decorator requested
1799
# bring up the server
1800
self.__readonly_server = ReadonlyServer()
1801
self.__readonly_server.setUp(self.get_vfs_only_server())
1803
self.__readonly_server = self.create_transport_readonly_server()
1804
self.__readonly_server.setUp(self.get_vfs_only_server())
1805
self.addCleanup(self.__readonly_server.tearDown)
1806
return self.__readonly_server
1808
def get_readonly_url(self, relpath=None):
1809
"""Get a URL for the readonly transport.
1811
This will either be backed by '.' or a decorator to the transport
1812
used by self.get_url()
1813
relpath provides for clients to get a path relative to the base url.
1814
These should only be downwards relative, not upwards.
1816
base = self.get_readonly_server().get_url()
1817
return self._adjust_url(base, relpath)
1819
def get_vfs_only_server(self):
1820
"""Get the vfs only read/write server instance.
1822
This is useful for some tests with specific servers that need
1825
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1826
is no means to override it.
1828
if self.__vfs_server is None:
1829
self.__vfs_server = MemoryServer()
1830
self.__vfs_server.setUp()
1831
self.addCleanup(self.__vfs_server.tearDown)
1832
return self.__vfs_server
1834
def get_server(self):
1835
"""Get the read/write server instance.
1837
This is useful for some tests with specific servers that need
1840
This is built from the self.transport_server factory. If that is None,
1841
then the self.get_vfs_server is returned.
1843
if self.__server is None:
1844
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1845
return self.get_vfs_only_server()
1847
# bring up a decorated means of access to the vfs only server.
1848
self.__server = self.transport_server()
1850
self.__server.setUp(self.get_vfs_only_server())
1851
except TypeError, e:
1852
# This should never happen; the try:Except here is to assist
1853
# developers having to update code rather than seeing an
1854
# uninformative TypeError.
1855
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1856
self.addCleanup(self.__server.tearDown)
1857
return self.__server
1859
def _adjust_url(self, base, relpath):
1860
"""Get a URL (or maybe a path) for the readwrite transport.
1862
This will either be backed by '.' or to an equivalent non-file based
1864
relpath provides for clients to get a path relative to the base url.
1865
These should only be downwards relative, not upwards.
1867
if relpath is not None and relpath != '.':
1868
if not base.endswith('/'):
1870
# XXX: Really base should be a url; we did after all call
1871
# get_url()! But sometimes it's just a path (from
1872
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1873
# to a non-escaped local path.
1874
if base.startswith('./') or base.startswith('/'):
1877
base += urlutils.escape(relpath)
1880
def get_url(self, relpath=None):
1881
"""Get a URL (or maybe a path) for the readwrite transport.
1883
This will either be backed by '.' or to an equivalent non-file based
1885
relpath provides for clients to get a path relative to the base url.
1886
These should only be downwards relative, not upwards.
1888
base = self.get_server().get_url()
1889
return self._adjust_url(base, relpath)
1891
def get_vfs_only_url(self, relpath=None):
1892
"""Get a URL (or maybe a path for the plain old vfs transport.
1894
This will never be a smart protocol. It always has all the
1895
capabilities of the local filesystem, but it might actually be a
1896
MemoryTransport or some other similar virtual filesystem.
1898
This is the backing transport (if any) of the server returned by
1899
get_url and get_readonly_url.
1901
:param relpath: provides for clients to get a path relative to the base
1902
url. These should only be downwards relative, not upwards.
1905
base = self.get_vfs_only_server().get_url()
1906
return self._adjust_url(base, relpath)
1908
def _create_safety_net(self):
1909
"""Make a fake bzr directory.
1911
This prevents any tests propagating up onto the TEST_ROOT directory's
1914
root = TestCaseWithMemoryTransport.TEST_ROOT
1915
bzrdir.BzrDir.create_standalone_workingtree(root)
1917
def _check_safety_net(self):
1918
"""Check that the safety .bzr directory have not been touched.
1920
_make_test_root have created a .bzr directory to prevent tests from
1921
propagating. This method ensures than a test did not leaked.
1923
root = TestCaseWithMemoryTransport.TEST_ROOT
1924
wt = workingtree.WorkingTree.open(root)
1925
last_rev = wt.last_revision()
1926
if last_rev != 'null:':
1927
# The current test have modified the /bzr directory, we need to
1928
# recreate a new one or all the followng tests will fail.
1929
# If you need to inspect its content uncomment the following line
1930
# import pdb; pdb.set_trace()
1931
_rmtree_temp_dir(root + '/.bzr')
1932
self._create_safety_net()
1933
raise AssertionError('%s/.bzr should not be modified' % root)
1935
def _make_test_root(self):
1936
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1937
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1938
TestCaseWithMemoryTransport.TEST_ROOT = root
1940
self._create_safety_net()
1942
# The same directory is used by all tests, and we're not
1943
# specifically told when all tests are finished. This will do.
1944
atexit.register(_rmtree_temp_dir, root)
1946
self.addCleanup(self._check_safety_net)
1948
def makeAndChdirToTestDir(self):
1949
"""Create a temporary directories for this one test.
1951
This must set self.test_home_dir and self.test_dir and chdir to
1954
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1956
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1957
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1958
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1960
def make_branch(self, relpath, format=None):
1961
"""Create a branch on the transport at relpath."""
1962
repo = self.make_repository(relpath, format=format)
1963
return repo.bzrdir.create_branch()
1965
def make_bzrdir(self, relpath, format=None):
1967
# might be a relative or absolute path
1968
maybe_a_url = self.get_url(relpath)
1969
segments = maybe_a_url.rsplit('/', 1)
1970
t = get_transport(maybe_a_url)
1971
if len(segments) > 1 and segments[-1] not in ('', '.'):
1975
if isinstance(format, basestring):
1976
format = bzrdir.format_registry.make_bzrdir(format)
1977
return format.initialize_on_transport(t)
1978
except errors.UninitializableFormat:
1979
raise TestSkipped("Format %s is not initializable." % format)
1981
def make_repository(self, relpath, shared=False, format=None):
1982
"""Create a repository on our default transport at relpath.
1984
Note that relpath must be a relative path, not a full url.
1986
# FIXME: If you create a remoterepository this returns the underlying
1987
# real format, which is incorrect. Actually we should make sure that
1988
# RemoteBzrDir returns a RemoteRepository.
1989
# maybe mbp 20070410
1990
made_control = self.make_bzrdir(relpath, format=format)
1991
return made_control.create_repository(shared=shared)
1993
def make_branch_and_memory_tree(self, relpath, format=None):
1994
"""Create a branch on the default transport and a MemoryTree for it."""
1995
b = self.make_branch(relpath, format=format)
1996
return memorytree.MemoryTree.create_on_branch(b)
1998
def make_branch_builder(self, relpath, format=None):
1999
url = self.get_url(relpath)
2000
tran = get_transport(url)
2001
return branchbuilder.BranchBuilder(get_transport(url), format=format)
2003
def overrideEnvironmentForTesting(self):
2004
os.environ['HOME'] = self.test_home_dir
2005
os.environ['BZR_HOME'] = self.test_home_dir
2008
super(TestCaseWithMemoryTransport, self).setUp()
2009
self._make_test_root()
2010
_currentdir = os.getcwdu()
2011
def _leaveDirectory():
2012
os.chdir(_currentdir)
2013
self.addCleanup(_leaveDirectory)
2014
self.makeAndChdirToTestDir()
2015
self.overrideEnvironmentForTesting()
2016
self.__readonly_server = None
2017
self.__server = None
2018
self.reduceLockdirTimeout()
876
class TestCaseInTempDir(TestCase):
2021
class TestCaseInTempDir(TestCaseWithMemoryTransport):
877
2022
"""Derived class that runs a test within a temporary directory.
879
2024
This is useful for tests that need to create a branch, etc.
1175
2264
def setUp(self):
1176
2265
super(ChrootedTestCase, self).setUp()
1177
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1178
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2266
if not self.vfs_transport_factory == MemoryServer:
2267
self.transport_readonly_server = HttpServer
2270
def condition_id_re(pattern):
2271
"""Create a condition filter which performs a re check on a test's id.
2273
:param pattern: A regular expression string.
2274
:return: A callable that returns True if the re matches.
2276
filter_re = re.compile(pattern)
2277
def condition(test):
2279
return filter_re.search(test_id)
2283
def condition_isinstance(klass_or_klass_list):
2284
"""Create a condition filter which returns isinstance(param, klass).
2286
:return: A callable which when called with one parameter obj return the
2287
result of isinstance(obj, klass_or_klass_list).
2290
return isinstance(obj, klass_or_klass_list)
2294
def condition_id_in_list(id_list):
2295
"""Create a condition filter which verify that test's id in a list.
2297
:param id_list: A TestIdList object.
2298
:return: A callable that returns True if the test's id appears in the list.
2300
def condition(test):
2301
return id_list.includes(test.id())
2305
def condition_id_startswith(start):
2306
"""Create a condition filter verifying that test's id starts with a string.
2308
:param start: A string.
2309
:return: A callable that returns True if the test's id starts with the
2312
def condition(test):
2313
return test.id().startswith(start)
2317
def exclude_tests_by_condition(suite, condition):
2318
"""Create a test suite which excludes some tests from suite.
2320
:param suite: The suite to get tests from.
2321
:param condition: A callable whose result evaluates True when called with a
2322
test case which should be excluded from the result.
2323
:return: A suite which contains the tests found in suite that fail
2327
for test in iter_suite_tests(suite):
2328
if not condition(test):
2330
return TestUtil.TestSuite(result)
2333
def filter_suite_by_condition(suite, condition):
2334
"""Create a test suite by filtering another one.
2336
:param suite: The source suite.
2337
:param condition: A callable whose result evaluates True when called with a
2338
test case which should be included in the result.
2339
:return: A suite which contains the tests found in suite that pass
2343
for test in iter_suite_tests(suite):
2346
return TestUtil.TestSuite(result)
1181
2349
def filter_suite_by_re(suite, pattern):
1182
result = TestUtil.TestSuite()
1183
filter_re = re.compile(pattern)
2350
"""Create a test suite by filtering another one.
2352
:param suite: the source suite
2353
:param pattern: pattern that names must match
2354
:returns: the newly created suite
2356
condition = condition_id_re(pattern)
2357
result_suite = filter_suite_by_condition(suite, condition)
2361
def filter_suite_by_id_list(suite, test_id_list):
2362
"""Create a test suite by filtering another one.
2364
:param suite: The source suite.
2365
:param test_id_list: A list of the test ids to keep as strings.
2366
:returns: the newly created suite
2368
condition = condition_id_in_list(test_id_list)
2369
result_suite = filter_suite_by_condition(suite, condition)
2373
def filter_suite_by_id_startswith(suite, start):
2374
"""Create a test suite by filtering another one.
2376
:param suite: The source suite.
2377
:param start: A string the test id must start with.
2378
:returns: the newly created suite
2380
condition = condition_id_startswith(start)
2381
result_suite = filter_suite_by_condition(suite, condition)
2385
def exclude_tests_by_re(suite, pattern):
2386
"""Create a test suite which excludes some tests from suite.
2388
:param suite: The suite to get tests from.
2389
:param pattern: A regular expression string. Test ids that match this
2390
pattern will be excluded from the result.
2391
:return: A TestSuite that contains all the tests from suite without the
2392
tests that matched pattern. The order of tests is the same as it was in
2395
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2398
def preserve_input(something):
2399
"""A helper for performing test suite transformation chains.
2401
:param something: Anything you want to preserve.
2407
def randomize_suite(suite):
2408
"""Return a new TestSuite with suite's tests in random order.
2410
The tests in the input suite are flattened into a single suite in order to
2411
accomplish this. Any nested TestSuites are removed to provide global
2414
tests = list(iter_suite_tests(suite))
2415
random.shuffle(tests)
2416
return TestUtil.TestSuite(tests)
2419
def split_suite_by_condition(suite, condition):
2420
"""Split a test suite into two by a condition.
2422
:param suite: The suite to split.
2423
:param condition: The condition to match on. Tests that match this
2424
condition are returned in the first test suite, ones that do not match
2425
are in the second suite.
2426
:return: A tuple of two test suites, where the first contains tests from
2427
suite matching the condition, and the second contains the remainder
2428
from suite. The order within each output suite is the same as it was in
1184
2433
for test in iter_suite_tests(suite):
1185
if filter_re.search(test.id()):
1186
result.addTest(test)
2435
matched.append(test)
2437
did_not_match.append(test)
2438
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2441
def split_suite_by_re(suite, pattern):
2442
"""Split a test suite into two by a regular expression.
2444
:param suite: The suite to split.
2445
:param pattern: A regular expression string. Test ids that match this
2446
pattern will be in the first test suite returned, and the others in the
2447
second test suite returned.
2448
:return: A tuple of two test suites, where the first contains tests from
2449
suite matching pattern, and the second contains the remainder from
2450
suite. The order within each output suite is the same as it was in
2453
return split_suite_by_condition(suite, condition_id_re(pattern))
1190
2456
def run_suite(suite, name='test', verbose=False, pattern=".*",
1191
stop_on_failure=False, keep_output=False,
1192
transport=None, lsprof_timed=None):
1193
TestCaseInTempDir._TEST_NAME = name
2457
stop_on_failure=False,
2458
transport=None, lsprof_timed=None, bench_history=None,
2459
matching_tests_first=None,
2462
exclude_pattern=None,
1194
2464
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1200
pb = progress.ProgressBar()
1201
2469
runner = TextTestRunner(stream=sys.stdout,
1202
2470
descriptions=0,
1203
2471
verbosity=verbosity,
1204
keep_output=keep_output,
2472
bench_history=bench_history,
2473
list_only=list_only,
1206
2475
runner.stop_on_failure=stop_on_failure
1208
suite = filter_suite_by_re(suite, pattern)
2476
# Initialise the random number generator and display the seed used.
2477
# We convert the seed to a long to make it reuseable across invocations.
2478
random_order = False
2479
if random_seed is not None:
2481
if random_seed == "now":
2482
random_seed = long(time.time())
2484
# Convert the seed to a long if we can
2486
random_seed = long(random_seed)
2489
runner.stream.writeln("Randomizing test order using seed %s\n" %
2491
random.seed(random_seed)
2492
# Customise the list of tests if requested
2493
if exclude_pattern is not None:
2494
suite = exclude_tests_by_re(suite, exclude_pattern)
2496
order_changer = randomize_suite
2498
order_changer = preserve_input
2499
if pattern != '.*' or random_order:
2500
if matching_tests_first:
2501
suites = map(order_changer, split_suite_by_re(suite, pattern))
2502
suite = TestUtil.TestSuite(suites)
2504
suite = order_changer(filter_suite_by_re(suite, pattern))
1209
2506
result = runner.run(suite)
2509
return result.wasStrictlySuccessful()
1210
2511
return result.wasSuccessful()
2514
# Controlled by "bzr selftest -E=..." option
2515
selftest_debug_flags = set()
1213
2518
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1215
2519
transport=None,
1216
2520
test_suite_factory=None,
2523
matching_tests_first=None,
2526
exclude_pattern=None,
1218
2532
"""Run the whole test suite under the enhanced runner"""
2533
# XXX: Very ugly way to do this...
2534
# Disable warning about old formats because we don't want it to disturb
2535
# any blackbox tests.
2536
from bzrlib import repository
2537
repository._deprecation_warning_done = True
1219
2539
global default_transport
1220
2540
if transport is None:
1221
2541
transport = default_transport
1222
2542
old_transport = default_transport
1223
2543
default_transport = transport
2544
global selftest_debug_flags
2545
old_debug_flags = selftest_debug_flags
2546
if debug_flags is not None:
2547
selftest_debug_flags = set(debug_flags)
2549
if load_list is None:
2552
keep_only = load_test_id_list(load_list)
1225
2553
if test_suite_factory is None:
1226
suite = test_suite()
2554
suite = test_suite(keep_only, starting_with)
1228
2556
suite = test_suite_factory()
1229
2557
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1230
stop_on_failure=stop_on_failure, keep_output=keep_output,
2558
stop_on_failure=stop_on_failure,
1231
2559
transport=transport,
1232
lsprof_timed=lsprof_timed)
2560
lsprof_timed=lsprof_timed,
2561
bench_history=bench_history,
2562
matching_tests_first=matching_tests_first,
2563
list_only=list_only,
2564
random_seed=random_seed,
2565
exclude_pattern=exclude_pattern,
1234
2568
default_transport = old_transport
2569
selftest_debug_flags = old_debug_flags
2572
def load_test_id_list(file_name):
2573
"""Load a test id list from a text file.
2575
The format is one test id by line. No special care is taken to impose
2576
strict rules, these test ids are used to filter the test suite so a test id
2577
that do not match an existing test will do no harm. This allows user to add
2578
comments, leave blank lines, etc.
2582
ftest = open(file_name, 'rt')
2584
if e.errno != errno.ENOENT:
2587
raise errors.NoSuchFile(file_name)
2589
for test_name in ftest.readlines():
2590
test_list.append(test_name.strip())
2595
def suite_matches_id_list(test_suite, id_list):
2596
"""Warns about tests not appearing or appearing more than once.
2598
:param test_suite: A TestSuite object.
2599
:param test_id_list: The list of test ids that should be found in
2602
:return: (absents, duplicates) absents is a list containing the test found
2603
in id_list but not in test_suite, duplicates is a list containing the
2604
test found multiple times in test_suite.
2606
When using a prefined test id list, it may occurs that some tests do not
2607
exist anymore or that some tests use the same id. This function warns the
2608
tester about potential problems in his workflow (test lists are volatile)
2609
or in the test suite itself (using the same id for several tests does not
2610
help to localize defects).
2612
# Build a dict counting id occurrences
2614
for test in iter_suite_tests(test_suite):
2616
tests[id] = tests.get(id, 0) + 1
2621
occurs = tests.get(id, 0)
2623
not_found.append(id)
2625
duplicates.append(id)
2627
return not_found, duplicates
2630
class TestIdList(object):
2631
"""Test id list to filter a test suite.
2633
Relying on the assumption that test ids are built as:
2634
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2635
notation, this class offers methods to :
2636
- avoid building a test suite for modules not refered to in the test list,
2637
- keep only the tests listed from the module test suite.
2640
def __init__(self, test_id_list):
2641
# When a test suite needs to be filtered against us we compare test ids
2642
# for equality, so a simple dict offers a quick and simple solution.
2643
self.tests = dict().fromkeys(test_id_list, True)
2645
# While unittest.TestCase have ids like:
2646
# <module>.<class>.<method>[(<param+)],
2647
# doctest.DocTestCase can have ids like:
2650
# <module>.<function>
2651
# <module>.<class>.<method>
2653
# Since we can't predict a test class from its name only, we settle on
2654
# a simple constraint: a test id always begins with its module name.
2657
for test_id in test_id_list:
2658
parts = test_id.split('.')
2659
mod_name = parts.pop(0)
2660
modules[mod_name] = True
2662
mod_name += '.' + part
2663
modules[mod_name] = True
2664
self.modules = modules
2666
def refers_to(self, module_name):
2667
"""Is there tests for the module or one of its sub modules."""
2668
return self.modules.has_key(module_name)
2670
def includes(self, test_id):
2671
return self.tests.has_key(test_id)
2674
def test_suite(keep_only=None, starting_with=None):
1238
2675
"""Build and return TestSuite for the whole of bzrlib.
2677
:param keep_only: A list of test ids limiting the suite returned.
2679
:param starting_with: An id limiting the suite returned to the tests
1240
2682
This function can be replaced if you need to change the default test
1241
2683
suite on a global basis, but it is not encouraged.
1243
2685
testmod_names = [
2687
'bzrlib.util.tests.test_bencode',
2688
'bzrlib.tests.blackbox',
2689
'bzrlib.tests.branch_implementations',
2690
'bzrlib.tests.bzrdir_implementations',
2691
'bzrlib.tests.commands',
2692
'bzrlib.tests.inventory_implementations',
2693
'bzrlib.tests.interrepository_implementations',
2694
'bzrlib.tests.intertree_implementations',
2695
'bzrlib.tests.per_lock',
2696
'bzrlib.tests.repository_implementations',
2697
'bzrlib.tests.test__dirstate_helpers',
1244
2698
'bzrlib.tests.test_ancestry',
2699
'bzrlib.tests.test_annotate',
1245
2700
'bzrlib.tests.test_api',
2701
'bzrlib.tests.test_atomicfile',
1246
2702
'bzrlib.tests.test_bad_files',
2703
'bzrlib.tests.test_bisect_multi',
1247
2704
'bzrlib.tests.test_branch',
2705
'bzrlib.tests.test_branchbuilder',
2706
'bzrlib.tests.test_bugtracker',
1248
2707
'bzrlib.tests.test_bundle',
1249
2708
'bzrlib.tests.test_bzrdir',
1250
'bzrlib.tests.test_command',
2709
'bzrlib.tests.test_cache_utf8',
2710
'bzrlib.tests.test_commands',
1251
2711
'bzrlib.tests.test_commit',
1252
2712
'bzrlib.tests.test_commit_merge',
1253
2713
'bzrlib.tests.test_config',
1254
2714
'bzrlib.tests.test_conflicts',
2715
'bzrlib.tests.test_counted_lock',
1255
2716
'bzrlib.tests.test_decorators',
2717
'bzrlib.tests.test_delta',
2718
'bzrlib.tests.test_deprecated_graph',
1256
2719
'bzrlib.tests.test_diff',
1257
'bzrlib.tests.test_doc_generate',
1258
'bzrlib.tests.test_emptytree',
2720
'bzrlib.tests.test_dirstate',
2721
'bzrlib.tests.test_directory_service',
2722
'bzrlib.tests.test_email_message',
1259
2723
'bzrlib.tests.test_errors',
1260
'bzrlib.tests.test_escaped_store',
2724
'bzrlib.tests.test_extract',
1261
2725
'bzrlib.tests.test_fetch',
2726
'bzrlib.tests.test_ftp_transport',
2727
'bzrlib.tests.test_generate_docs',
2728
'bzrlib.tests.test_generate_ids',
2729
'bzrlib.tests.test_globbing',
1262
2730
'bzrlib.tests.test_gpg',
1263
2731
'bzrlib.tests.test_graph',
1264
2732
'bzrlib.tests.test_hashcache',
2733
'bzrlib.tests.test_help',
2734
'bzrlib.tests.test_hooks',
1265
2735
'bzrlib.tests.test_http',
2736
'bzrlib.tests.test_http_implementations',
1266
2737
'bzrlib.tests.test_http_response',
2738
'bzrlib.tests.test_https_ca_bundle',
1267
2739
'bzrlib.tests.test_identitymap',
2740
'bzrlib.tests.test_ignores',
2741
'bzrlib.tests.test_index',
2742
'bzrlib.tests.test_info',
1268
2743
'bzrlib.tests.test_inv',
1269
2744
'bzrlib.tests.test_knit',
2745
'bzrlib.tests.test_lazy_import',
2746
'bzrlib.tests.test_lazy_regex',
1270
2747
'bzrlib.tests.test_lockdir',
1271
2748
'bzrlib.tests.test_lockable_files',
1272
2749
'bzrlib.tests.test_log',
2750
'bzrlib.tests.test_lsprof',
2751
'bzrlib.tests.test_lru_cache',
2752
'bzrlib.tests.test_mail_client',
2753
'bzrlib.tests.test_memorytree',
1273
2754
'bzrlib.tests.test_merge',
1274
2755
'bzrlib.tests.test_merge3',
1275
2756
'bzrlib.tests.test_merge_core',
2757
'bzrlib.tests.test_merge_directive',
1276
2758
'bzrlib.tests.test_missing',
1277
2759
'bzrlib.tests.test_msgeditor',
2760
'bzrlib.tests.test_multiparent',
2761
'bzrlib.tests.test_mutabletree',
1278
2762
'bzrlib.tests.test_nonascii',
1279
2763
'bzrlib.tests.test_options',
1280
2764
'bzrlib.tests.test_osutils',
2765
'bzrlib.tests.test_osutils_encodings',
2766
'bzrlib.tests.test_pack',
2767
'bzrlib.tests.test_pack_repository',
1281
2768
'bzrlib.tests.test_patch',
1282
2769
'bzrlib.tests.test_patches',
1283
2770
'bzrlib.tests.test_permissions',
1284
2771
'bzrlib.tests.test_plugins',
1285
2772
'bzrlib.tests.test_progress',
2773
'bzrlib.tests.test_read_bundle',
2774
'bzrlib.tests.test_reconfigure',
1286
2775
'bzrlib.tests.test_reconcile',
2776
'bzrlib.tests.test_registry',
2777
'bzrlib.tests.test_remote',
1287
2778
'bzrlib.tests.test_repository',
2779
'bzrlib.tests.per_repository_reference',
2780
'bzrlib.tests.test_revert',
1288
2781
'bzrlib.tests.test_revision',
1289
'bzrlib.tests.test_revisionnamespaces',
1290
'bzrlib.tests.test_revprops',
2782
'bzrlib.tests.test_revisionspec',
1291
2783
'bzrlib.tests.test_revisiontree',
1292
2784
'bzrlib.tests.test_rio',
2785
'bzrlib.tests.test_rules',
1293
2786
'bzrlib.tests.test_sampler',
1294
2787
'bzrlib.tests.test_selftest',
1295
2788
'bzrlib.tests.test_setup',
1296
2789
'bzrlib.tests.test_sftp_transport',
2790
'bzrlib.tests.test_smart',
1297
2791
'bzrlib.tests.test_smart_add',
2792
'bzrlib.tests.test_smart_transport',
2793
'bzrlib.tests.test_smtp_connection',
1298
2794
'bzrlib.tests.test_source',
2795
'bzrlib.tests.test_ssh_transport',
1299
2796
'bzrlib.tests.test_status',
1300
2797
'bzrlib.tests.test_store',
2798
'bzrlib.tests.test_strace',
2799
'bzrlib.tests.test_subsume',
2800
'bzrlib.tests.test_switch',
1301
2801
'bzrlib.tests.test_symbol_versioning',
2802
'bzrlib.tests.test_tag',
1302
2803
'bzrlib.tests.test_testament',
1303
2804
'bzrlib.tests.test_textfile',
1304
2805
'bzrlib.tests.test_textmerge',
2806
'bzrlib.tests.test_timestamp',
1305
2807
'bzrlib.tests.test_trace',
1306
2808
'bzrlib.tests.test_transactions',
1307
2809
'bzrlib.tests.test_transform',
1308
2810
'bzrlib.tests.test_transport',
2811
'bzrlib.tests.test_transport_implementations',
2812
'bzrlib.tests.test_tree',
2813
'bzrlib.tests.test_treebuilder',
1309
2814
'bzrlib.tests.test_tsort',
1310
2815
'bzrlib.tests.test_tuned_gzip',
1311
2816
'bzrlib.tests.test_ui',
2817
'bzrlib.tests.test_uncommit',
1312
2818
'bzrlib.tests.test_upgrade',
2819
'bzrlib.tests.test_upgrade_stacked',
1313
2820
'bzrlib.tests.test_urlutils',
1314
2821
'bzrlib.tests.test_versionedfile',
2822
'bzrlib.tests.test_version',
2823
'bzrlib.tests.test_version_info',
2824
'bzrlib.tests.test__walkdirs_win32',
1315
2825
'bzrlib.tests.test_weave',
1316
2826
'bzrlib.tests.test_whitebox',
2827
'bzrlib.tests.test_win32utils',
1317
2828
'bzrlib.tests.test_workingtree',
2829
'bzrlib.tests.test_workingtree_4',
2830
'bzrlib.tests.test_wsgi',
1318
2831
'bzrlib.tests.test_xml',
2832
'bzrlib.tests.tree_implementations',
2833
'bzrlib.tests.workingtree_implementations',
1320
test_transport_implementations = [
1321
'bzrlib.tests.test_transport_implementations',
1322
'bzrlib.tests.test_read_bundle',
1324
suite = TestUtil.TestSuite()
1325
2836
loader = TestUtil.TestLoader()
1326
from bzrlib.transport import TransportTestProviderAdapter
1327
adapter = TransportTestProviderAdapter()
1328
adapt_modules(test_transport_implementations, adapter, loader, suite)
2838
if starting_with is not None:
2839
# We take precedence over keep_only because *at loading time* using
2840
# both options means we will load less tests for the same final result.
2841
def interesting_module(name):
2843
# Either the module name starts with the specified string
2844
name.startswith(starting_with)
2845
# or it may contain tests starting with the specified string
2846
or starting_with.startswith(name)
2848
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
2850
elif keep_only is not None:
2851
id_filter = TestIdList(keep_only)
2852
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2853
def interesting_module(name):
2854
return id_filter.refers_to(name)
2857
loader = TestUtil.TestLoader()
2858
def interesting_module(name):
2859
# No filtering, all modules are interesting
2862
suite = loader.suiteClass()
2864
# modules building their suite with loadTestsFromModuleNames
1329
2865
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1330
for package in packages_to_test():
1331
suite.addTest(package.test_suite())
1332
for m in MODULES_TO_TEST:
1333
suite.addTest(loader.loadTestsFromModule(m))
1334
for m in MODULES_TO_DOCTEST:
1335
suite.addTest(doctest.DocTestSuite(m))
1336
for name, plugin in bzrlib.plugin.all_plugins().items():
1337
if getattr(plugin, 'test_suite', None) is not None:
1338
suite.addTest(plugin.test_suite())
2867
modules_to_doctest = [
2872
'bzrlib.iterablefile',
2877
'bzrlib.symbol_versioning',
2880
'bzrlib.version_info_formats.format_custom',
2883
for mod in modules_to_doctest:
2884
if not interesting_module(mod):
2885
# No tests to keep here, move along
2888
doc_suite = doctest.DocTestSuite(mod)
2889
except ValueError, e:
2890
print '**failed to get doctest for: %s\n%s' % (mod, e)
2892
suite.addTest(doc_suite)
2894
default_encoding = sys.getdefaultencoding()
2895
for name, plugin in bzrlib.plugin.plugins().items():
2896
if not interesting_module(plugin.module.__name__):
2898
plugin_suite = plugin.test_suite()
2899
# We used to catch ImportError here and turn it into just a warning,
2900
# but really if you don't have --no-plugins this should be a failure.
2901
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2902
if plugin_suite is None:
2903
plugin_suite = plugin.load_plugin_tests(loader)
2904
if plugin_suite is not None:
2905
suite.addTest(plugin_suite)
2906
if default_encoding != sys.getdefaultencoding():
2907
bzrlib.trace.warning(
2908
'Plugin "%s" tried to reset default encoding to: %s', name,
2909
sys.getdefaultencoding())
2911
sys.setdefaultencoding(default_encoding)
2913
if starting_with is not None:
2914
suite = filter_suite_by_id_startswith(suite, starting_with)
2916
if keep_only is not None:
2917
# Now that the referred modules have loaded their tests, keep only the
2919
suite = filter_suite_by_id_list(suite, id_filter)
2920
# Do some sanity checks on the id_list filtering
2921
not_found, duplicates = suite_matches_id_list(suite, keep_only)
2922
if starting_with is not None:
2923
# The tester has used both keep_only and starting_with, so he is
2924
# already aware that some tests are excluded from the list, there
2925
# is no need to tell him which.
2928
# Some tests mentioned in the list are not in the test suite. The
2929
# list may be out of date, report to the tester.
2930
for id in not_found:
2931
bzrlib.trace.warning('"%s" not found in the test suite', id)
2932
for id in duplicates:
2933
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2938
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2939
"""Adapt all tests in some given modules to given scenarios.
2941
This is the recommended public interface for test parameterization.
2942
Typically the test_suite() method for a per-implementation test
2943
suite will call multiply_tests_from_modules and return the
2946
:param module_name_list: List of fully-qualified names of test
2948
:param scenario_iter: Iterable of pairs of (scenario_name,
2949
scenario_param_dict).
2950
:param loader: If provided, will be used instead of a new
2951
bzrlib.tests.TestLoader() instance.
2953
This returns a new TestSuite containing the cross product of
2954
all the tests in all the modules, each repeated for each scenario.
2955
Each test is adapted by adding the scenario name at the end
2956
of its name, and updating the test object's __dict__ with the
2957
scenario_param_dict.
2959
>>> r = multiply_tests_from_modules(
2960
... ['bzrlib.tests.test_sampler'],
2961
... [('one', dict(param=1)),
2962
... ('two', dict(param=2))])
2963
>>> tests = list(iter_suite_tests(r))
2967
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2973
# XXX: Isn't load_tests() a better way to provide the same functionality
2974
# without forcing a predefined TestScenarioApplier ? --vila 080215
2976
loader = TestUtil.TestLoader()
2978
suite = loader.suiteClass()
2980
adapter = TestScenarioApplier()
2981
adapter.scenarios = list(scenario_iter)
2982
adapt_modules(module_name_list, adapter, loader, suite)
2986
def multiply_scenarios(scenarios_left, scenarios_right):
2987
"""Multiply two sets of scenarios.
2989
:returns: the cartesian product of the two sets of scenarios, that is
2990
a scenario for every possible combination of a left scenario and a
2994
('%s,%s' % (left_name, right_name),
2995
dict(left_dict.items() + right_dict.items()))
2996
for left_name, left_dict in scenarios_left
2997
for right_name, right_dict in scenarios_right]
1342
3001
def adapt_modules(mods_list, adapter, loader, suite):
1343
3002
"""Adapt the modules in mods_list using adapter and add to suite."""
1344
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
3003
tests = loader.loadTestsFromModuleNames(mods_list)
3004
adapt_tests(tests, adapter, suite)
3007
def adapt_tests(tests_list, adapter, suite):
3008
"""Adapt the tests in tests_list using adapter and add to suite."""
3009
for test in iter_suite_tests(tests_list):
1345
3010
suite.addTests(adapter.adapt(test))
3013
def _rmtree_temp_dir(dirname):
3014
# If LANG=C we probably have created some bogus paths
3015
# which rmtree(unicode) will fail to delete
3016
# so make sure we are using rmtree(str) to delete everything
3017
# except on win32, where rmtree(str) will fail
3018
# since it doesn't have the property of byte-stream paths
3019
# (they are either ascii or mbcs)
3020
if sys.platform == 'win32':
3021
# make sure we are using the unicode win32 api
3022
dirname = unicode(dirname)
3024
dirname = dirname.encode(sys.getfilesystemencoding())
3026
osutils.rmtree(dirname)
3028
if sys.platform == 'win32' and e.errno == errno.EACCES:
3029
sys.stderr.write(('Permission denied: '
3030
'unable to remove testing dir '
3031
'%s\n' % os.path.basename(dirname)))
3036
class Feature(object):
3037
"""An operating system Feature."""
3040
self._available = None
3042
def available(self):
3043
"""Is the feature available?
3045
:return: True if the feature is available.
3047
if self._available is None:
3048
self._available = self._probe()
3049
return self._available
3052
"""Implement this method in concrete features.
3054
:return: True if the feature is available.
3056
raise NotImplementedError
3059
if getattr(self, 'feature_name', None):
3060
return self.feature_name()
3061
return self.__class__.__name__
3064
class _SymlinkFeature(Feature):
3067
return osutils.has_symlinks()
3069
def feature_name(self):
3072
SymlinkFeature = _SymlinkFeature()
3075
class _HardlinkFeature(Feature):
3078
return osutils.has_hardlinks()
3080
def feature_name(self):
3083
HardlinkFeature = _HardlinkFeature()
3086
class _OsFifoFeature(Feature):
3089
return getattr(os, 'mkfifo', None)
3091
def feature_name(self):
3092
return 'filesystem fifos'
3094
OsFifoFeature = _OsFifoFeature()
3097
class _UnicodeFilenameFeature(Feature):
3098
"""Does the filesystem support Unicode filenames?"""
3102
# Check for character combinations unlikely to be covered by any
3103
# single non-unicode encoding. We use the characters
3104
# - greek small letter alpha (U+03B1) and
3105
# - braille pattern dots-123456 (U+283F).
3106
os.stat(u'\u03b1\u283f')
3107
except UnicodeEncodeError:
3109
except (IOError, OSError):
3110
# The filesystem allows the Unicode filename but the file doesn't
3114
# The filesystem allows the Unicode filename and the file exists,
3118
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3121
class TestScenarioApplier(object):
3122
"""A tool to apply scenarios to tests."""
3124
def adapt(self, test):
3125
"""Return a TestSuite containing a copy of test for each scenario."""
3126
result = unittest.TestSuite()
3127
for scenario in self.scenarios:
3128
result.addTest(self.adapt_test_to_scenario(test, scenario))
3131
def adapt_test_to_scenario(self, test, scenario):
3132
"""Copy test and apply scenario to it.
3134
:param test: A test to adapt.
3135
:param scenario: A tuple describing the scenarion.
3136
The first element of the tuple is the new test id.
3137
The second element is a dict containing attributes to set on the
3139
:return: The adapted test.
3141
from copy import deepcopy
3142
new_test = deepcopy(test)
3143
for name, value in scenario[1].items():
3144
setattr(new_test, name, value)
3145
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3146
new_test.id = lambda: new_id
3150
def probe_unicode_in_user_encoding():
3151
"""Try to encode several unicode strings to use in unicode-aware tests.
3152
Return first successfull match.
3154
:return: (unicode value, encoded plain string value) or (None, None)
3156
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3157
for uni_val in possible_vals:
3159
str_val = uni_val.encode(bzrlib.user_encoding)
3160
except UnicodeEncodeError:
3161
# Try a different character
3164
return uni_val, str_val
3168
def probe_bad_non_ascii(encoding):
3169
"""Try to find [bad] character with code [128..255]
3170
that cannot be decoded to unicode in some encoding.
3171
Return None if all non-ascii characters is valid
3174
for i in xrange(128, 256):
3177
char.decode(encoding)
3178
except UnicodeDecodeError:
3183
class _FTPServerFeature(Feature):
3184
"""Some tests want an FTP Server, check if one is available.
3186
Right now, the only way this is available is if 'medusa' is installed.
3187
http://www.amk.ca/python/code/medusa.html
3192
import bzrlib.tests.ftp_server
3197
def feature_name(self):
3200
FTPServerFeature = _FTPServerFeature()
3203
class _UnicodeFilename(Feature):
3204
"""Does the filesystem support Unicode filenames?"""
3209
except UnicodeEncodeError:
3211
except (IOError, OSError):
3212
# The filesystem allows the Unicode filename but the file doesn't
3216
# The filesystem allows the Unicode filename and the file exists,
3220
UnicodeFilename = _UnicodeFilename()
3223
class _UTF8Filesystem(Feature):
3224
"""Is the filesystem UTF-8?"""
3227
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3231
UTF8Filesystem = _UTF8Filesystem()
3234
class _CaseInsensitiveFilesystemFeature(Feature):
3235
"""Check if underlined filesystem is case-insensitive
3236
(e.g. on Windows, Cygwin, MacOS)
3240
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3241
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3242
TestCaseWithMemoryTransport.TEST_ROOT = root
3244
root = TestCaseWithMemoryTransport.TEST_ROOT
3245
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3247
name_a = osutils.pathjoin(tdir, 'a')
3248
name_A = osutils.pathjoin(tdir, 'A')
3250
result = osutils.isdir(name_A)
3251
_rmtree_temp_dir(tdir)
3254
def feature_name(self):
3255
return 'case-insensitive filesystem'
3257
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
