1
# Copyright (C) 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
30
18
from cStringIO import StringIO
39
from subprocess import Popen, PIPE
46
from bzrlib import memorytree
48
import bzrlib.bzrdir as bzrdir
49
30
import bzrlib.commands
50
import bzrlib.bundle.serializer
51
import bzrlib.errors as errors
52
import bzrlib.inventory
53
import bzrlib.iterablefile
58
# lsprof not available
60
from bzrlib.merge import merge_inner
63
32
import bzrlib.osutils as osutils
65
import bzrlib.progress as progress
66
from bzrlib.revision import common_ancestor
68
from bzrlib import symbol_versioning
70
from bzrlib.transport import get_transport
71
import bzrlib.transport
72
from bzrlib.transport.local import LocalRelpathServer
73
from bzrlib.transport.readonly import ReadonlyServer
74
33
from bzrlib.trace import mutter
75
from bzrlib.tests import TestUtil
76
from bzrlib.tests.TestUtil import (
80
from bzrlib.tests.treeshape import build_tree_contents
81
import bzrlib.urlutils as urlutils
82
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
84
default_transport = LocalRelpathServer
34
from bzrlib.selftest import TestUtil
35
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
36
from bzrlib.selftest.treeshape import build_tree_contents
37
from bzrlib.errors import BzrError
86
39
MODULES_TO_TEST = []
87
MODULES_TO_DOCTEST = [
89
bzrlib.bundle.serializer,
103
def packages_to_test():
104
"""Return a list of packages to test.
106
The packages are not globally imported so that import failures are
107
triggered when running selftest, not when importing the command.
110
import bzrlib.tests.blackbox
111
import bzrlib.tests.branch_implementations
112
import bzrlib.tests.bzrdir_implementations
113
import bzrlib.tests.interrepository_implementations
114
import bzrlib.tests.interversionedfile_implementations
115
import bzrlib.tests.intertree_implementations
116
import bzrlib.tests.repository_implementations
117
import bzrlib.tests.revisionstore_implementations
118
import bzrlib.tests.tree_implementations
119
import bzrlib.tests.workingtree_implementations
122
bzrlib.tests.blackbox,
123
bzrlib.tests.branch_implementations,
124
bzrlib.tests.bzrdir_implementations,
125
bzrlib.tests.interrepository_implementations,
126
bzrlib.tests.interversionedfile_implementations,
127
bzrlib.tests.intertree_implementations,
128
bzrlib.tests.repository_implementations,
129
bzrlib.tests.revisionstore_implementations,
130
bzrlib.tests.tree_implementations,
131
bzrlib.tests.workingtree_implementations,
40
MODULES_TO_DOCTEST = []
44
class EarlyStoppingTestResultAdapter(object):
45
"""An adapter for TestResult to stop at the first first failure or error"""
47
def __init__(self, result):
50
def addError(self, test, err):
51
self._result.addError(test, err)
54
def addFailure(self, test, err):
55
self._result.addFailure(test, err)
58
def __getattr__(self, name):
59
return getattr(self._result, name)
61
def __setattr__(self, name, value):
63
object.__setattr__(self, name, value)
64
return setattr(self._result, name, value)
135
67
class _MyResult(unittest._TextTestResult):
136
68
"""Custom TestResult.
138
Shows output in a different format, including displaying runtime for tests.
70
No special behaviour for now.
142
def __init__(self, stream, descriptions, verbosity, pb=None,
144
"""Construct new TestResult.
146
:param bench_history: Optionally, a writable file object to accumulate
149
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
151
if bench_history is not None:
152
from bzrlib.version import _get_bzr_source_tree
153
src_tree = _get_bzr_source_tree()
156
revision_id = src_tree.get_parent_ids()[0]
158
# XXX: if this is a brand new tree, do the same as if there
162
# XXX: If there's no branch, what should we do?
164
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
165
self._bench_history = bench_history
167
def extractBenchmarkTime(self, testCase):
168
"""Add a benchmark time for the current test case."""
169
self._benchmarkTime = getattr(testCase, "_benchtime", None)
171
def _elapsedTestTimeString(self):
172
"""Return a time string for the overall time the current test has taken."""
173
return self._formatTime(time.time() - self._start_time)
175
def _testTimeString(self):
176
if self._benchmarkTime is not None:
178
self._formatTime(self._benchmarkTime),
179
self._elapsedTestTimeString())
181
return " %s" % self._elapsedTestTimeString()
183
def _formatTime(self, seconds):
184
"""Format seconds as milliseconds with leading spaces."""
185
return "%5dms" % (1000 * seconds)
187
def _ellipsise_unimportant_words(self, a_string, final_width,
189
"""Add ellipses (sp?) for overly long strings.
191
:param keep_start: If true preserve the start of a_string rather
195
if len(a_string) > final_width:
196
result = a_string[:final_width-3] + '...'
200
if len(a_string) > final_width:
201
result = '...' + a_string[3-final_width:]
204
return result.ljust(final_width)
73
# assumes 80-column window, less 'ERROR 99999ms' = 13ch
74
def _elapsedTime(self):
75
return "%5dms" % (1000 * (time.time() - self._start_time))
206
77
def startTest(self, test):
207
78
unittest.TestResult.startTest(self, test)
208
# In a short description, the important words are in
209
# the beginning, but in an id, the important words are
211
SHOW_DESCRIPTIONS = False
213
if not self.showAll and self.dots and self.pb is not None:
216
final_width = osutils.terminal_width()
217
final_width = final_width - 15 - 8
219
if SHOW_DESCRIPTIONS:
220
what = test.shortDescription()
222
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
225
if what.startswith('bzrlib.tests.'):
227
what = self._ellipsise_unimportant_words(what, final_width)
79
# TODO: Maybe show test.shortDescription somewhere?
80
what = test.shortDescription() or test.id()
81
pref = 'bzrlib.selftest.'
82
if what.startswith(pref):
83
what = what[len(pref):]
229
self.stream.write(what)
230
elif self.dots and self.pb is not None:
231
self.pb.update(what, self.testsRun - 1, None)
85
self.stream.write('%-65.65s' % what)
232
86
self.stream.flush()
233
self._recordTestStartTime()
235
def _recordTestStartTime(self):
236
"""Record that a test has started."""
237
87
self._start_time = time.time()
239
89
def addError(self, test, err):
240
if isinstance(err[1], TestSkipped):
241
return self.addSkipped(test, err)
242
90
unittest.TestResult.addError(self, test, err)
243
self.extractBenchmarkTime(test)
245
self.stream.writeln("ERROR %s" % self._testTimeString())
246
elif self.dots and self.pb is None:
92
self.stream.writeln("ERROR %s" % self._elapsedTime())
247
94
self.stream.write('E')
249
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
250
self.pb.note(self._ellipsise_unimportant_words(
251
test.id() + ': ERROR',
252
osutils.terminal_width()))
253
95
self.stream.flush()
257
97
def addFailure(self, test, err):
258
98
unittest.TestResult.addFailure(self, test, err)
259
self.extractBenchmarkTime(test)
261
self.stream.writeln(" FAIL %s" % self._testTimeString())
262
elif self.dots and self.pb is None:
100
self.stream.writeln(" FAIL %s" % self._elapsedTime())
263
102
self.stream.write('F')
265
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
266
self.pb.note(self._ellipsise_unimportant_words(
267
test.id() + ': FAIL',
268
osutils.terminal_width()))
269
103
self.stream.flush()
273
105
def addSuccess(self, test):
274
self.extractBenchmarkTime(test)
275
if self._bench_history is not None:
276
if self._benchmarkTime is not None:
277
self._bench_history.write("%s %s\n" % (
278
self._formatTime(self._benchmarkTime),
281
self.stream.writeln(' OK %s' % self._testTimeString())
282
for bench_called, stats in getattr(test, '_benchcalls', []):
283
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
284
stats.pprint(file=self.stream)
285
elif self.dots and self.pb is None:
107
self.stream.writeln(' OK %s' % self._elapsedTime())
286
109
self.stream.write('~')
288
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
289
110
self.stream.flush()
290
111
unittest.TestResult.addSuccess(self, test)
292
def addSkipped(self, test, skip_excinfo):
293
self.extractBenchmarkTime(test)
295
print >>self.stream, ' SKIP %s' % self._testTimeString()
296
print >>self.stream, ' %s' % skip_excinfo[1]
297
elif self.dots and self.pb is None:
298
self.stream.write('S')
300
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
302
# seems best to treat this as success from point-of-view of unittest
303
# -- it actually does nothing so it barely matters :)
306
except KeyboardInterrupt:
309
self.addError(test, test.__exc_info())
311
unittest.TestResult.addSuccess(self, test)
313
113
def printErrorList(self, flavour, errors):
314
114
for test, err in errors:
315
115
self.stream.writeln(self.separator1)
316
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
317
if getattr(test, '_get_log', None) is not None:
319
print >>self.stream, \
320
('vvvv[log from %s]' % test.id()).ljust(78,'-')
116
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
117
if hasattr(test, '_get_log'):
118
self.stream.writeln()
119
self.stream.writeln('log from this test:')
321
120
print >>self.stream, test._get_log()
322
print >>self.stream, \
323
('^^^^[log from %s]' % test.id()).ljust(78,'-')
324
121
self.stream.writeln(self.separator2)
325
122
self.stream.writeln("%s" % err)
328
class TextTestRunner(object):
125
class TextTestRunner(unittest.TextTestRunner):
329
126
stop_on_failure = False
338
self.stream = unittest._WritelnDecorator(stream)
339
self.descriptions = descriptions
340
self.verbosity = verbosity
341
self.keep_output = keep_output
343
self._bench_history = bench_history
345
128
def _makeResult(self):
346
result = _MyResult(self.stream,
350
bench_history=self._bench_history)
351
result.stop_early = self.stop_on_failure
355
"Run the given test case or test suite."
356
result = self._makeResult()
357
startTime = time.time()
358
if self.pb is not None:
359
self.pb.update('Running tests', 0, test.countTestCases())
361
stopTime = time.time()
362
timeTaken = stopTime - startTime
364
self.stream.writeln(result.separator2)
365
run = result.testsRun
366
self.stream.writeln("Ran %d test%s in %.3fs" %
367
(run, run != 1 and "s" or "", timeTaken))
368
self.stream.writeln()
369
if not result.wasSuccessful():
370
self.stream.write("FAILED (")
371
failed, errored = map(len, (result.failures, result.errors))
373
self.stream.write("failures=%d" % failed)
375
if failed: self.stream.write(", ")
376
self.stream.write("errors=%d" % errored)
377
self.stream.writeln(")")
379
self.stream.writeln("OK")
380
if self.pb is not None:
381
self.pb.update('Cleaning up', 0, 1)
382
# This is still a little bogus,
383
# but only a little. Folk not using our testrunner will
384
# have to delete their temp directories themselves.
385
test_root = TestCaseInTempDir.TEST_ROOT
386
if result.wasSuccessful() or not self.keep_output:
387
if test_root is not None:
388
# If LANG=C we probably have created some bogus paths
389
# which rmtree(unicode) will fail to delete
390
# so make sure we are using rmtree(str) to delete everything
391
# except on win32, where rmtree(str) will fail
392
# since it doesn't have the property of byte-stream paths
393
# (they are either ascii or mbcs)
394
if sys.platform == 'win32':
395
# make sure we are using the unicode win32 api
396
test_root = unicode(test_root)
398
test_root = test_root.encode(
399
sys.getfilesystemencoding())
400
osutils.rmtree(test_root)
402
if self.pb is not None:
403
self.pb.note("Failed tests working directories are in '%s'\n",
407
"Failed tests working directories are in '%s'\n" %
409
TestCaseInTempDir.TEST_ROOT = None
410
if self.pb is not None:
129
result = _MyResult(self.stream, self.descriptions, self.verbosity)
130
if self.stop_on_failure:
131
result = EarlyStoppingTestResultAdapter(result)
545
218
raise AssertionError('pattern "%s" not found in "%s"'
546
219
% (needle_re, haystack))
548
def assertNotContainsRe(self, haystack, needle_re):
549
"""Assert that a does not match a regular expression"""
550
if re.search(needle_re, haystack):
551
raise AssertionError('pattern "%s" found in "%s"'
552
% (needle_re, haystack))
554
def assertSubset(self, sublist, superlist):
555
"""Assert that every entry in sublist is present in superlist."""
557
for entry in sublist:
558
if entry not in superlist:
559
missing.append(entry)
561
raise AssertionError("value(s) %r not present in container %r" %
562
(missing, superlist))
564
def assertIs(self, left, right):
565
if not (left is right):
566
raise AssertionError("%r is not %r." % (left, right))
568
def assertTransportMode(self, transport, path, mode):
569
"""Fail if a path does not have mode mode.
571
If modes are not supported on this transport, the assertion is ignored.
573
if not transport._can_roundtrip_unix_modebits():
575
path_stat = transport.stat(path)
576
actual_mode = stat.S_IMODE(path_stat.st_mode)
577
self.assertEqual(mode, actual_mode,
578
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
580
def assertIsInstance(self, obj, kls):
581
"""Fail if obj is not an instance of kls"""
582
if not isinstance(obj, kls):
583
self.fail("%r is an instance of %s rather than %s" % (
584
obj, obj.__class__, kls))
586
def _capture_warnings(self, a_callable, *args, **kwargs):
587
"""A helper for callDeprecated and applyDeprecated.
589
:param a_callable: A callable to call.
590
:param args: The positional arguments for the callable
591
:param kwargs: The keyword arguments for the callable
592
:return: A tuple (warnings, result). result is the result of calling
593
a_callable(*args, **kwargs).
596
def capture_warnings(msg, cls, stacklevel=None):
597
# we've hooked into a deprecation specific callpath,
598
# only deprecations should getting sent via it.
599
self.assertEqual(cls, DeprecationWarning)
600
local_warnings.append(msg)
601
original_warning_method = symbol_versioning.warn
602
symbol_versioning.set_warning_method(capture_warnings)
604
result = a_callable(*args, **kwargs)
606
symbol_versioning.set_warning_method(original_warning_method)
607
return (local_warnings, result)
609
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
610
"""Call a deprecated callable without warning the user.
612
:param deprecation_format: The deprecation format that the callable
613
should have been deprecated with. This is the same type as the
614
parameter to deprecated_method/deprecated_function. If the
615
callable is not deprecated with this format, an assertion error
617
:param a_callable: A callable to call. This may be a bound method or
618
a regular function. It will be called with *args and **kwargs.
619
:param args: The positional arguments for the callable
620
:param kwargs: The keyword arguments for the callable
621
:return: The result of a_callable(*args, **kwargs)
623
call_warnings, result = self._capture_warnings(a_callable,
625
expected_first_warning = symbol_versioning.deprecation_string(
626
a_callable, deprecation_format)
627
if len(call_warnings) == 0:
628
self.fail("No assertion generated by call to %s" %
630
self.assertEqual(expected_first_warning, call_warnings[0])
633
def callDeprecated(self, expected, callable, *args, **kwargs):
634
"""Assert that a callable is deprecated in a particular way.
636
This is a very precise test for unusual requirements. The
637
applyDeprecated helper function is probably more suited for most tests
638
as it allows you to simply specify the deprecation format being used
639
and will ensure that that is issued for the function being called.
641
:param expected: a list of the deprecation warnings expected, in order
642
:param callable: The callable to call
643
:param args: The positional arguments for the callable
644
:param kwargs: The keyword arguments for the callable
646
call_warnings, result = self._capture_warnings(callable,
648
self.assertEqual(expected, call_warnings)
651
221
def _startLogFile(self):
652
222
"""Send bzr and test log messages to a temporary file.
827
368
This sends the stdout/stderr results into the test's log,
828
369
where it may be useful for debugging. See also run_captured.
830
:param stdin: A string to be used as stdin for the command.
832
371
retcode = kwargs.pop('retcode', 0)
833
encoding = kwargs.pop('encoding', None)
834
stdin = kwargs.pop('stdin', None)
835
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
837
def run_bzr_decode(self, *args, **kwargs):
838
if 'encoding' in kwargs:
839
encoding = kwargs['encoding']
841
encoding = bzrlib.user_encoding
842
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
844
def run_bzr_error(self, error_regexes, *args, **kwargs):
845
"""Run bzr, and check that stderr contains the supplied regexes
847
:param error_regexes: Sequence of regular expressions which
848
must each be found in the error output. The relative ordering
850
:param args: command-line arguments for bzr
851
:param kwargs: Keyword arguments which are interpreted by run_bzr
852
This function changes the default value of retcode to be 3,
853
since in most cases this is run when you expect bzr to fail.
854
:return: (out, err) The actual output of running the command (in case you
855
want to do more inspection)
858
# Make sure that commit is failing because there is nothing to do
859
self.run_bzr_error(['no changes to commit'],
860
'commit', '-m', 'my commit comment')
861
# Make sure --strict is handling an unknown file, rather than
862
# giving us the 'nothing to do' error
863
self.build_tree(['unknown'])
864
self.run_bzr_error(['Commit refused because there are unknown files'],
865
'commit', '--strict', '-m', 'my commit comment')
867
kwargs.setdefault('retcode', 3)
868
out, err = self.run_bzr(*args, **kwargs)
869
for regex in error_regexes:
870
self.assertContainsRe(err, regex)
873
def run_bzr_subprocess(self, *args, **kwargs):
874
"""Run bzr in a subprocess for testing.
876
This starts a new Python interpreter and runs bzr in there.
877
This should only be used for tests that have a justifiable need for
878
this isolation: e.g. they are testing startup time, or signal
879
handling, or early startup code, etc. Subprocess code can't be
880
profiled or debugged so easily.
882
:param retcode: The status code that is expected. Defaults to 0. If
883
None is supplied, the status code is not checked.
884
:param env_changes: A dictionary which lists changes to environment
885
variables. A value of None will unset the env variable.
886
The values must be strings. The change will only occur in the
887
child, so you don't need to fix the environment after running.
888
:param universal_newlines: Convert CRLF => LF
890
env_changes = kwargs.get('env_changes', {})
891
process = self.start_bzr_subprocess(args, env_changes=env_changes)
892
# We distinguish between retcode=None and retcode not passed.
893
supplied_retcode = kwargs.get('retcode', 0)
894
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
895
universal_newlines=kwargs.get('universal_newlines', False),
898
def start_bzr_subprocess(self, process_args, env_changes=None,
899
skip_if_plan_to_signal=False):
900
"""Start bzr in a subprocess for testing.
902
This starts a new Python interpreter and runs bzr in there.
903
This should only be used for tests that have a justifiable need for
904
this isolation: e.g. they are testing startup time, or signal
905
handling, or early startup code, etc. Subprocess code can't be
906
profiled or debugged so easily.
908
:param process_args: a list of arguments to pass to the bzr executable,
909
for example `['--version']`.
910
:param env_changes: A dictionary which lists changes to environment
911
variables. A value of None will unset the env variable.
912
The values must be strings. The change will only occur in the
913
child, so you don't need to fix the environment after running.
914
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
917
:returns: Popen object for the started process.
919
if skip_if_plan_to_signal:
920
if not getattr(os, 'kill', None):
921
raise TestSkipped("os.kill not available.")
923
if env_changes is None:
927
def cleanup_environment():
928
for env_var, value in env_changes.iteritems():
929
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
931
def restore_environment():
932
for env_var, value in old_env.iteritems():
933
osutils.set_or_unset_env(env_var, value)
935
bzr_path = self.get_bzr_path()
938
# win32 subprocess doesn't support preexec_fn
939
# so we will avoid using it on all platforms, just to
940
# make sure the code path is used, and we don't break on win32
941
cleanup_environment()
942
process = Popen([sys.executable, bzr_path] + list(process_args),
943
stdin=PIPE, stdout=PIPE, stderr=PIPE)
945
restore_environment()
948
def get_bzr_path(self):
949
"""Return the path of the 'bzr' executable for this test suite."""
950
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
951
if not os.path.isfile(bzr_path):
952
# We are probably installed. Assume sys.argv is the right file
953
bzr_path = sys.argv[0]
956
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
957
universal_newlines=False, process_args=None):
958
"""Finish the execution of process.
960
:param process: the Popen object returned from start_bzr_subprocess.
961
:param retcode: The status code that is expected. Defaults to 0. If
962
None is supplied, the status code is not checked.
963
:param send_signal: an optional signal to send to the process.
964
:param universal_newlines: Convert CRLF => LF
965
:returns: (stdout, stderr)
967
if send_signal is not None:
968
os.kill(process.pid, send_signal)
969
out, err = process.communicate()
971
if universal_newlines:
972
out = out.replace('\r\n', '\n')
973
err = err.replace('\r\n', '\n')
975
if retcode is not None and retcode != process.returncode:
976
if process_args is None:
977
process_args = "(unknown args)"
978
mutter('Output of bzr %s:\n%s', process_args, out)
979
mutter('Error for bzr %s:\n%s', process_args, err)
980
self.fail('Command bzr %s failed with retcode %s != %s'
981
% (process_args, retcode, process.returncode))
372
return self.run_bzr_captured(args, retcode)
984
374
def check_inventory_shape(self, inv, shape):
985
375
"""Compare an inventory to a list of expected names.
1096
469
# successfully created
1097
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
470
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
1099
472
# make a fake bzr directory there to prevent any tests propagating
1100
473
# up onto the source directory's real branch
1101
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
474
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
1103
476
def setUp(self):
1104
477
super(TestCaseInTempDir, self).setUp()
1105
478
self._make_test_root()
1106
479
_currentdir = os.getcwdu()
1107
# shorten the name, to avoid test failures due to path length
1108
short_id = self.id().replace('bzrlib.tests.', '') \
1109
.replace('__main__.', '')[-100:]
1110
# it's possible the same test class is run several times for
1111
# parameterized tests, so make sure the names don't collide.
1115
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1117
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1118
if os.path.exists(candidate_dir):
1122
os.mkdir(candidate_dir)
1123
self.test_home_dir = candidate_dir + '/home'
1124
os.mkdir(self.test_home_dir)
1125
self.test_dir = candidate_dir + '/work'
1126
os.mkdir(self.test_dir)
1127
os.chdir(self.test_dir)
1129
os.environ['HOME'] = self.test_home_dir
1130
os.environ['APPDATA'] = self.test_home_dir
480
short_id = self.id().replace('bzrlib.selftest.', '') \
481
.replace('__main__.', '')
482
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
483
os.mkdir(self.test_dir)
484
os.chdir(self.test_dir)
485
os.environ['HOME'] = self.test_dir
1131
486
def _leaveDirectory():
1132
487
os.chdir(_currentdir)
1133
488
self.addCleanup(_leaveDirectory)
1135
def build_tree(self, shape, line_endings='native', transport=None):
490
def build_tree(self, shape, line_endings='native'):
1136
491
"""Build a test tree according to a pattern.
1138
493
shape is a sequence of file specifications. If the final
1139
494
character is '/', a directory is created.
1141
This assumes that all the elements in the tree being built are new.
1143
496
This doesn't add anything to a branch.
1144
497
:param line_endings: Either 'binary' or 'native'
1145
498
in binary mode, exact contents are written
1146
499
in native mode, the line endings match the
1147
500
default platform endings.
1149
:param transport: A transport to write to, for building trees on
1150
VFS's. If the transport is readonly or None,
1151
"." is opened automatically.
1153
# It's OK to just create them using forward slashes on windows.
1154
if transport is None or transport.is_readonly():
1155
transport = get_transport(".")
502
# XXX: It's OK to just create them using forward slashes on windows?
1156
503
for name in shape:
1157
504
self.assert_(isinstance(name, basestring))
1158
505
if name[-1] == '/':
1159
transport.mkdir(urlutils.escape(name[:-1]))
1161
508
if line_endings == 'binary':
1163
510
elif line_endings == 'native':
1166
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1167
content = "contents of %s%s" % (name.encode('utf-8'), end)
1168
# Technically 'put()' is the right command. However, put
1169
# uses an AtomicFile, which requires an extra rename into place
1170
# As long as the files didn't exist in the past, append() will
1171
# do the same thing as put()
1172
# On jam's machine, make_kernel_like_tree is:
1173
# put: 4.5-7.5s (averaging 6s)
1175
# put_non_atomic: 2.9-4.5s
1176
transport.put_bytes_non_atomic(urlutils.escape(name), content)
513
raise BzrError('Invalid line ending request %r' % (line_endings,))
514
print >>f, "contents of", name
1178
517
def build_tree_contents(self, shape):
1179
build_tree_contents(shape)
518
bzrlib.selftest.build_tree_contents(shape)
1181
520
def failUnlessExists(self, path):
1182
521
"""Fail unless path, which may be abs or relative, exists."""
1183
522
self.failUnless(osutils.lexists(path))
1185
def failIfExists(self, path):
1186
"""Fail if path, which may be abs or relative, exists."""
1187
self.failIf(osutils.lexists(path))
1189
524
def assertFileEqual(self, content, path):
1190
525
"""Fail if path does not contain 'content'."""
1191
526
self.failUnless(osutils.lexists(path))
1192
# TODO: jam 20060427 Shouldn't this be 'rb'?
1193
527
self.assertEqualDiff(content, open(path, 'r').read())
1196
class TestCaseWithTransport(TestCaseInTempDir):
1197
"""A test case that provides get_url and get_readonly_url facilities.
1199
These back onto two transport servers, one for readonly access and one for
1202
If no explicit class is provided for readonly access, a
1203
ReadonlyTransportDecorator is used instead which allows the use of non disk
1204
based read write transports.
1206
If an explicit class is provided for readonly access, that server and the
1207
readwrite one must both define get_url() as resolving to os.getcwd().
1210
def __init__(self, methodName='testMethod'):
1211
super(TestCaseWithTransport, self).__init__(methodName)
1212
self.__readonly_server = None
1213
self.__server = None
1214
self.transport_server = default_transport
1215
self.transport_readonly_server = None
1217
def get_readonly_url(self, relpath=None):
1218
"""Get a URL for the readonly transport.
1220
This will either be backed by '.' or a decorator to the transport
1221
used by self.get_url()
1222
relpath provides for clients to get a path relative to the base url.
1223
These should only be downwards relative, not upwards.
1225
base = self.get_readonly_server().get_url()
1226
if relpath is not None:
1227
if not base.endswith('/'):
1229
base = base + relpath
1232
def get_readonly_server(self):
1233
"""Get the server instance for the readonly transport
1235
This is useful for some tests with specific servers to do diagnostics.
1237
if self.__readonly_server is None:
1238
if self.transport_readonly_server is None:
1239
# readonly decorator requested
1240
# bring up the server
1242
self.__readonly_server = ReadonlyServer()
1243
self.__readonly_server.setUp(self.__server)
1245
self.__readonly_server = self.transport_readonly_server()
1246
self.__readonly_server.setUp()
1247
self.addCleanup(self.__readonly_server.tearDown)
1248
return self.__readonly_server
1250
def get_server(self):
1251
"""Get the read/write server instance.
1253
This is useful for some tests with specific servers that need
1256
if self.__server is None:
1257
self.__server = self.transport_server()
1258
self.__server.setUp()
1259
self.addCleanup(self.__server.tearDown)
1260
return self.__server
1262
def get_url(self, relpath=None):
1263
"""Get a URL (or maybe a path) for the readwrite transport.
1265
This will either be backed by '.' or to an equivalent non-file based
1267
relpath provides for clients to get a path relative to the base url.
1268
These should only be downwards relative, not upwards.
1270
base = self.get_server().get_url()
1271
if relpath is not None and relpath != '.':
1272
if not base.endswith('/'):
1274
# XXX: Really base should be a url; we did after all call
1275
# get_url()! But sometimes it's just a path (from
1276
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1277
# to a non-escaped local path.
1278
if base.startswith('./') or base.startswith('/'):
1281
base += urlutils.escape(relpath)
1284
def get_transport(self):
1285
"""Return a writeable transport for the test scratch space"""
1286
t = get_transport(self.get_url())
1287
self.assertFalse(t.is_readonly())
1290
def get_readonly_transport(self):
1291
"""Return a readonly transport for the test scratch space
1293
This can be used to test that operations which should only need
1294
readonly access in fact do not try to write.
1296
t = get_transport(self.get_readonly_url())
1297
self.assertTrue(t.is_readonly())
1300
def make_branch(self, relpath, format=None):
1301
"""Create a branch on the transport at relpath."""
1302
repo = self.make_repository(relpath, format=format)
1303
return repo.bzrdir.create_branch()
1305
def make_bzrdir(self, relpath, format=None):
1307
# might be a relative or absolute path
1308
maybe_a_url = self.get_url(relpath)
1309
segments = maybe_a_url.rsplit('/', 1)
1310
t = get_transport(maybe_a_url)
1311
if len(segments) > 1 and segments[-1] not in ('', '.'):
1314
except errors.FileExists:
1317
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1318
return format.initialize_on_transport(t)
1319
except errors.UninitializableFormat:
1320
raise TestSkipped("Format %s is not initializable." % format)
1322
def make_repository(self, relpath, shared=False, format=None):
1323
"""Create a repository on our default transport at relpath."""
1324
made_control = self.make_bzrdir(relpath, format=format)
1325
return made_control.create_repository(shared=shared)
1327
def make_branch_and_memory_tree(self, relpath):
1328
"""Create a branch on the default transport and a MemoryTree for it."""
1329
b = self.make_branch(relpath)
1330
return memorytree.MemoryTree.create_on_branch(b)
1332
def make_branch_and_tree(self, relpath, format=None):
1333
"""Create a branch on the transport and a tree locally.
1335
If the transport is not a LocalTransport, the Tree can't be created on
1336
the transport. In that case the working tree is created in the local
1337
directory, and the returned tree's branch and repository will also be
1340
This will fail if the original default transport for this test
1341
case wasn't backed by the working directory, as the branch won't
1342
be on disk for us to open it.
1344
:param format: The BzrDirFormat.
1345
:returns: the WorkingTree.
1347
# TODO: always use the local disk path for the working tree,
1348
# this obviously requires a format that supports branch references
1349
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1351
b = self.make_branch(relpath, format=format)
1353
return b.bzrdir.create_workingtree()
1354
except errors.NotLocalUrl:
1355
# We can only make working trees locally at the moment. If the
1356
# transport can't support them, then reopen the branch on a local
1357
# transport, and create the working tree there.
1359
# Possibly we should instead keep
1360
# the non-disk-backed branch and create a local checkout?
1361
bd = bzrdir.BzrDir.open(relpath)
1362
return bd.create_workingtree()
1364
def assertIsDirectory(self, relpath, transport):
1365
"""Assert that relpath within transport is a directory.
1367
This may not be possible on all transports; in that case it propagates
1368
a TransportNotPossible.
1371
mode = transport.stat(relpath).st_mode
1372
except errors.NoSuchFile:
1373
self.fail("path %s is not a directory; no such file"
1375
if not stat.S_ISDIR(mode):
1376
self.fail("path %s is not a directory; has mode %#o"
1380
class ChrootedTestCase(TestCaseWithTransport):
1381
"""A support class that provides readonly urls outside the local namespace.
1383
This is done by checking if self.transport_server is a MemoryServer. if it
1384
is then we are chrooted already, if it is not then an HttpServer is used
1387
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1388
be used without needed to redo it when a different
1389
subclass is in use ?
1393
super(ChrootedTestCase, self).setUp()
1394
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1395
self.transport_readonly_server = bzrlib.transport.http.HttpServer
530
class MetaTestLog(TestCase):
531
def test_logging(self):
532
"""Test logs are captured when a test fails."""
533
self.log('a test message')
534
self._log_file.flush()
535
self.assertContainsRe(self._get_log(), 'a test message\n')
1398
538
def filter_suite_by_re(suite, pattern):
1407
547
def run_suite(suite, name='test', verbose=False, pattern=".*",
1408
stop_on_failure=False, keep_output=False,
1409
transport=None, lsprof_timed=None, bench_history=None):
548
stop_on_failure=False, keep_output=False):
1410
549
TestCaseInTempDir._TEST_NAME = name
1411
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1417
pb = progress.ProgressBar()
1418
554
runner = TextTestRunner(stream=sys.stdout,
1420
verbosity=verbosity,
1421
keep_output=keep_output,
1423
bench_history=bench_history)
1424
557
runner.stop_on_failure=stop_on_failure
1425
558
if pattern != '.*':
1426
559
suite = filter_suite_by_re(suite, pattern)
1427
560
result = runner.run(suite)
561
# This is still a little bogus,
562
# but only a little. Folk not using our testrunner will
563
# have to delete their temp directories themselves.
564
if result.wasSuccessful() or not keep_output:
565
if TestCaseInTempDir.TEST_ROOT is not None:
566
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
568
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
1428
569
return result.wasSuccessful()
1431
572
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1434
test_suite_factory=None,
1436
bench_history=None):
1437
574
"""Run the whole test suite under the enhanced runner"""
1438
# XXX: Very ugly way to do this...
1439
# Disable warning about old formats because we don't want it to disturb
1440
# any blackbox tests.
1441
from bzrlib import repository
1442
repository._deprecation_warning_done = True
1444
global default_transport
1445
if transport is None:
1446
transport = default_transport
1447
old_transport = default_transport
1448
default_transport = transport
1450
if test_suite_factory is None:
1451
suite = test_suite()
1453
suite = test_suite_factory()
1454
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1455
stop_on_failure=stop_on_failure, keep_output=keep_output,
1456
transport=transport,
1457
lsprof_timed=lsprof_timed,
1458
bench_history=bench_history)
1460
default_transport = old_transport
575
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
576
stop_on_failure=stop_on_failure, keep_output=keep_output)
1463
579
def test_suite():
1464
"""Build and return TestSuite for the whole of bzrlib.
1466
This function can be replaced if you need to change the default test
1467
suite on a global basis, but it is not encouraged.
1470
'bzrlib.tests.test_ancestry',
1471
'bzrlib.tests.test_api',
1472
'bzrlib.tests.test_atomicfile',
1473
'bzrlib.tests.test_bad_files',
1474
'bzrlib.tests.test_branch',
1475
'bzrlib.tests.test_bundle',
1476
'bzrlib.tests.test_bzrdir',
1477
'bzrlib.tests.test_cache_utf8',
1478
'bzrlib.tests.test_command',
1479
'bzrlib.tests.test_commit',
1480
'bzrlib.tests.test_commit_merge',
1481
'bzrlib.tests.test_config',
1482
'bzrlib.tests.test_conflicts',
1483
'bzrlib.tests.test_decorators',
1484
'bzrlib.tests.test_diff',
1485
'bzrlib.tests.test_doc_generate',
1486
'bzrlib.tests.test_errors',
1487
'bzrlib.tests.test_escaped_store',
1488
'bzrlib.tests.test_fetch',
1489
'bzrlib.tests.test_ftp_transport',
1490
'bzrlib.tests.test_gpg',
1491
'bzrlib.tests.test_graph',
1492
'bzrlib.tests.test_hashcache',
1493
'bzrlib.tests.test_http',
1494
'bzrlib.tests.test_http_response',
1495
'bzrlib.tests.test_identitymap',
1496
'bzrlib.tests.test_ignores',
1497
'bzrlib.tests.test_inv',
1498
'bzrlib.tests.test_knit',
1499
'bzrlib.tests.test_lazy_import',
1500
'bzrlib.tests.test_lockdir',
1501
'bzrlib.tests.test_lockable_files',
1502
'bzrlib.tests.test_log',
1503
'bzrlib.tests.test_memorytree',
1504
'bzrlib.tests.test_merge',
1505
'bzrlib.tests.test_merge3',
1506
'bzrlib.tests.test_merge_core',
1507
'bzrlib.tests.test_missing',
1508
'bzrlib.tests.test_msgeditor',
1509
'bzrlib.tests.test_nonascii',
1510
'bzrlib.tests.test_options',
1511
'bzrlib.tests.test_osutils',
1512
'bzrlib.tests.test_patch',
1513
'bzrlib.tests.test_patches',
1514
'bzrlib.tests.test_permissions',
1515
'bzrlib.tests.test_plugins',
1516
'bzrlib.tests.test_progress',
1517
'bzrlib.tests.test_reconcile',
1518
'bzrlib.tests.test_repository',
1519
'bzrlib.tests.test_revert',
1520
'bzrlib.tests.test_revision',
1521
'bzrlib.tests.test_revisionnamespaces',
1522
'bzrlib.tests.test_revisiontree',
1523
'bzrlib.tests.test_rio',
1524
'bzrlib.tests.test_sampler',
1525
'bzrlib.tests.test_selftest',
1526
'bzrlib.tests.test_setup',
1527
'bzrlib.tests.test_sftp_transport',
1528
'bzrlib.tests.test_smart_add',
1529
'bzrlib.tests.test_smart_transport',
1530
'bzrlib.tests.test_source',
1531
'bzrlib.tests.test_status',
1532
'bzrlib.tests.test_store',
1533
'bzrlib.tests.test_symbol_versioning',
1534
'bzrlib.tests.test_testament',
1535
'bzrlib.tests.test_textfile',
1536
'bzrlib.tests.test_textmerge',
1537
'bzrlib.tests.test_trace',
1538
'bzrlib.tests.test_transactions',
1539
'bzrlib.tests.test_transform',
1540
'bzrlib.tests.test_transport',
1541
'bzrlib.tests.test_tree',
1542
'bzrlib.tests.test_treebuilder',
1543
'bzrlib.tests.test_tsort',
1544
'bzrlib.tests.test_tuned_gzip',
1545
'bzrlib.tests.test_ui',
1546
'bzrlib.tests.test_upgrade',
1547
'bzrlib.tests.test_urlutils',
1548
'bzrlib.tests.test_versionedfile',
1549
'bzrlib.tests.test_version',
1550
'bzrlib.tests.test_weave',
1551
'bzrlib.tests.test_whitebox',
1552
'bzrlib.tests.test_workingtree',
1553
'bzrlib.tests.test_xml',
580
"""Build and return TestSuite for the whole program."""
581
import bzrlib.store, bzrlib.inventory, bzrlib.branch
582
import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
583
from doctest import DocTestSuite
585
global MODULES_TO_TEST, MODULES_TO_DOCTEST
587
# FIXME: If these fail to load, e.g. because of a syntax error, the
588
# exception is hidden by unittest. Sucks. Should either fix that or
589
# perhaps import them and pass them to unittest as modules.
591
['bzrlib.selftest.MetaTestLog',
592
'bzrlib.selftest.testapi',
593
'bzrlib.selftest.testgpg',
594
'bzrlib.selftest.testidentitymap',
595
'bzrlib.selftest.testinv',
596
'bzrlib.selftest.test_ancestry',
597
'bzrlib.selftest.test_commit',
598
'bzrlib.selftest.test_command',
599
'bzrlib.selftest.test_commit_merge',
600
'bzrlib.selftest.testconfig',
601
'bzrlib.selftest.versioning',
602
'bzrlib.selftest.testmerge3',
603
'bzrlib.selftest.testmerge',
604
'bzrlib.selftest.testhashcache',
605
'bzrlib.selftest.teststatus',
606
'bzrlib.selftest.testlog',
607
'bzrlib.selftest.testrevisionnamespaces',
608
'bzrlib.selftest.testbranch',
609
'bzrlib.selftest.testrevision',
610
'bzrlib.selftest.test_revision_info',
611
'bzrlib.selftest.test_merge_core',
612
'bzrlib.selftest.test_smart_add',
613
'bzrlib.selftest.test_bad_files',
614
'bzrlib.selftest.testdiff',
615
'bzrlib.selftest.test_parent',
616
'bzrlib.selftest.test_xml',
617
'bzrlib.selftest.test_weave',
618
'bzrlib.selftest.testfetch',
619
'bzrlib.selftest.whitebox',
620
'bzrlib.selftest.teststore',
621
'bzrlib.selftest.blackbox',
622
'bzrlib.selftest.testsampler',
623
'bzrlib.selftest.testtransactions',
624
'bzrlib.selftest.testtransport',
625
'bzrlib.selftest.testsftp',
626
'bzrlib.selftest.testgraph',
627
'bzrlib.selftest.testworkingtree',
628
'bzrlib.selftest.test_upgrade',
629
'bzrlib.selftest.test_conflicts',
630
'bzrlib.selftest.testtestament',
631
'bzrlib.selftest.testannotate',
632
'bzrlib.selftest.testrevprops',
633
'bzrlib.selftest.testoptions',
634
'bzrlib.selftest.testhttp',
635
'bzrlib.selftest.testnonascii',
636
'bzrlib.selftest.testreweave',
637
'bzrlib.selftest.testtsort',
638
'bzrlib.selftest.testtrace',
639
'bzrlib.selftest.testbasicio',
1555
test_transport_implementations = [
1556
'bzrlib.tests.test_transport_implementations',
1557
'bzrlib.tests.test_read_bundle',
1559
suite = TestUtil.TestSuite()
1560
loader = TestUtil.TestLoader()
1561
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1562
from bzrlib.transport import TransportTestProviderAdapter
1563
adapter = TransportTestProviderAdapter()
1564
adapt_modules(test_transport_implementations, adapter, loader, suite)
1565
for package in packages_to_test():
1566
suite.addTest(package.test_suite())
642
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
643
bzrlib.osutils, bzrlib.commands, bzrlib.merge3,
646
if m not in MODULES_TO_DOCTEST:
647
MODULES_TO_DOCTEST.append(m)
649
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
650
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
653
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
1567
654
for m in MODULES_TO_TEST:
1568
suite.addTest(loader.loadTestsFromModule(m))
1569
for m in MODULES_TO_DOCTEST:
1570
suite.addTest(doctest.DocTestSuite(m))
1571
for name, plugin in bzrlib.plugin.all_plugins().items():
1572
if getattr(plugin, 'test_suite', None) is not None:
1573
suite.addTest(plugin.test_suite())
655
suite.addTest(TestLoader().loadTestsFromModule(m))
656
for m in (MODULES_TO_DOCTEST):
657
suite.addTest(DocTestSuite(m))
658
for p in bzrlib.plugin.all_plugins:
659
if hasattr(p, 'test_suite'):
660
suite.addTest(p.test_suite())
1577
def adapt_modules(mods_list, adapter, loader, suite):
1578
"""Adapt the modules in mods_list using adapter and add to suite."""
1579
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1580
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/selftest/__init__.py
