1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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
from cStringIO import StringIO
36
from pprint import pformat
40
from subprocess import Popen, PIPE
58
import bzrlib.commands
59
import bzrlib.timestamp
61
import bzrlib.inventory
62
import bzrlib.iterablefile
67
# lsprof not available
69
from bzrlib.merge import merge_inner
73
from bzrlib.revision import common_ancestor
75
from bzrlib import symbol_versioning
77
from bzrlib.transport import get_transport
78
import bzrlib.transport
79
from bzrlib.transport.local import LocalURLServer
80
from bzrlib.transport.memory import MemoryServer
81
from bzrlib.transport.readonly import ReadonlyServer
82
from bzrlib.trace import mutter, note
83
from bzrlib.tests import TestUtil
84
from bzrlib.tests.HttpServer import HttpServer
85
from bzrlib.tests.TestUtil import (
89
from bzrlib.tests.treeshape import build_tree_contents
90
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
92
default_transport = LocalURLServer
95
MODULES_TO_DOCTEST = [
107
NUMBERED_DIRS = False # dirs kind for TestCaseInTempDir (numbered or named)
110
def packages_to_test():
111
"""Return a list of packages to test.
113
The packages are not globally imported so that import failures are
114
triggered when running selftest, not when importing the command.
117
import bzrlib.tests.blackbox
118
import bzrlib.tests.branch_implementations
119
import bzrlib.tests.bzrdir_implementations
120
import bzrlib.tests.interrepository_implementations
121
import bzrlib.tests.interversionedfile_implementations
122
import bzrlib.tests.intertree_implementations
123
import bzrlib.tests.per_lock
124
import bzrlib.tests.repository_implementations
125
import bzrlib.tests.revisionstore_implementations
126
import bzrlib.tests.tree_implementations
127
import bzrlib.tests.workingtree_implementations
130
bzrlib.tests.blackbox,
131
bzrlib.tests.branch_implementations,
132
bzrlib.tests.bzrdir_implementations,
133
bzrlib.tests.interrepository_implementations,
134
bzrlib.tests.interversionedfile_implementations,
135
bzrlib.tests.intertree_implementations,
136
bzrlib.tests.per_lock,
137
bzrlib.tests.repository_implementations,
138
bzrlib.tests.revisionstore_implementations,
139
bzrlib.tests.tree_implementations,
140
bzrlib.tests.workingtree_implementations,
144
class ExtendedTestResult(unittest._TextTestResult):
145
"""Accepts, reports and accumulates the results of running tests.
147
Compared to this unittest version this class adds support for profiling,
148
benchmarking, stopping as soon as a test fails, and skipping tests.
149
There are further-specialized subclasses for different types of display.
154
def __init__(self, stream, descriptions, verbosity,
158
"""Construct new TestResult.
160
:param bench_history: Optionally, a writable file object to accumulate
163
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
164
if bench_history is not None:
165
from bzrlib.version import _get_bzr_source_tree
166
src_tree = _get_bzr_source_tree()
169
revision_id = src_tree.get_parent_ids()[0]
171
# XXX: if this is a brand new tree, do the same as if there
175
# XXX: If there's no branch, what should we do?
177
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
178
self._bench_history = bench_history
179
self.ui = ui.ui_factory
180
self.num_tests = num_tests
182
self.failure_count = 0
183
self.known_failure_count = 0
185
self.unsupported = {}
187
self._overall_start_time = time.time()
189
def extractBenchmarkTime(self, testCase):
190
"""Add a benchmark time for the current test case."""
191
self._benchmarkTime = getattr(testCase, "_benchtime", None)
193
def _elapsedTestTimeString(self):
194
"""Return a time string for the overall time the current test has taken."""
195
return self._formatTime(time.time() - self._start_time)
197
def _testTimeString(self):
198
if self._benchmarkTime is not None:
200
self._formatTime(self._benchmarkTime),
201
self._elapsedTestTimeString())
203
return " %s" % self._elapsedTestTimeString()
205
def _formatTime(self, seconds):
206
"""Format seconds as milliseconds with leading spaces."""
207
# some benchmarks can take thousands of seconds to run, so we need 8
209
return "%8dms" % (1000 * seconds)
211
def _shortened_test_description(self, test):
213
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
216
def startTest(self, test):
217
unittest.TestResult.startTest(self, test)
218
self.report_test_start(test)
219
test.number = self.count
220
self._recordTestStartTime()
222
def _recordTestStartTime(self):
223
"""Record that a test has started."""
224
self._start_time = time.time()
226
def _cleanupLogFile(self, test):
227
# We can only do this if we have one of our TestCases, not if
229
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
230
if setKeepLogfile is not None:
233
def addError(self, test, err):
234
self.extractBenchmarkTime(test)
235
self._cleanupLogFile(test)
236
if isinstance(err[1], TestSkipped):
237
return self.addSkipped(test, err)
238
elif isinstance(err[1], UnavailableFeature):
239
return self.addNotSupported(test, err[1].args[0])
240
unittest.TestResult.addError(self, test, err)
241
self.error_count += 1
242
self.report_error(test, err)
246
def addFailure(self, test, err):
247
self._cleanupLogFile(test)
248
self.extractBenchmarkTime(test)
249
if isinstance(err[1], KnownFailure):
250
return self.addKnownFailure(test, err)
251
unittest.TestResult.addFailure(self, test, err)
252
self.failure_count += 1
253
self.report_failure(test, err)
257
def addKnownFailure(self, test, err):
258
self.known_failure_count += 1
259
self.report_known_failure(test, err)
261
def addNotSupported(self, test, feature):
262
self.unsupported.setdefault(str(feature), 0)
263
self.unsupported[str(feature)] += 1
264
self.report_unsupported(test, feature)
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
273
self.report_success(test)
274
unittest.TestResult.addSuccess(self, test)
276
def addSkipped(self, test, skip_excinfo):
277
self.report_skip(test, skip_excinfo)
278
# seems best to treat this as success from point-of-view of unittest
279
# -- it actually does nothing so it barely matters :)
282
except KeyboardInterrupt:
285
self.addError(test, test.__exc_info())
287
unittest.TestResult.addSuccess(self, test)
289
def printErrorList(self, flavour, errors):
290
for test, err in errors:
291
self.stream.writeln(self.separator1)
292
self.stream.write("%s: " % flavour)
294
self.stream.write('#%d ' % test.number)
295
self.stream.writeln(self.getDescription(test))
296
if getattr(test, '_get_log', None) is not None:
298
print >>self.stream, \
299
('vvvv[log from %s]' % test.id()).ljust(78,'-')
300
print >>self.stream, test._get_log()
301
print >>self.stream, \
302
('^^^^[log from %s]' % test.id()).ljust(78,'-')
303
self.stream.writeln(self.separator2)
304
self.stream.writeln("%s" % err)
309
def report_cleaning_up(self):
312
def report_success(self, test):
316
class TextTestResult(ExtendedTestResult):
317
"""Displays progress and results of tests in text form"""
319
def __init__(self, stream, descriptions, verbosity,
324
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
325
bench_history, num_tests)
327
self.pb = self.ui.nested_progress_bar()
328
self._supplied_pb = False
331
self._supplied_pb = True
332
self.pb.show_pct = False
333
self.pb.show_spinner = False
334
self.pb.show_eta = False,
335
self.pb.show_count = False
336
self.pb.show_bar = False
338
def report_starting(self):
339
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
341
def _progress_prefix_text(self):
342
a = '[%d' % self.count
343
if self.num_tests is not None:
344
a +='/%d' % self.num_tests
345
a += ' in %ds' % (time.time() - self._overall_start_time)
347
a += ', %d errors' % self.error_count
348
if self.failure_count:
349
a += ', %d failed' % self.failure_count
350
if self.known_failure_count:
351
a += ', %d known failures' % self.known_failure_count
353
a += ', %d skipped' % self.skip_count
355
a += ', %d missing features' % len(self.unsupported)
359
def report_test_start(self, test):
362
self._progress_prefix_text()
364
+ self._shortened_test_description(test))
366
def _test_description(self, test):
368
return '#%d %s' % (self.count,
369
self._shortened_test_description(test))
371
return self._shortened_test_description(test)
373
def report_error(self, test, err):
374
self.pb.note('ERROR: %s\n %s\n',
375
self._test_description(test),
379
def report_failure(self, test, err):
380
self.pb.note('FAIL: %s\n %s\n',
381
self._test_description(test),
385
def report_known_failure(self, test, err):
386
self.pb.note('XFAIL: %s\n%s\n',
387
self._test_description(test), err[1])
389
def report_skip(self, test, skip_excinfo):
392
# at the moment these are mostly not things we can fix
393
# and so they just produce stipple; use the verbose reporter
396
# show test and reason for skip
397
self.pb.note('SKIP: %s\n %s\n',
398
self._shortened_test_description(test),
401
# since the class name was left behind in the still-visible
403
self.pb.note('SKIP: %s', skip_excinfo[1])
405
def report_unsupported(self, test, feature):
406
"""test cannot be run because feature is missing."""
408
def report_cleaning_up(self):
409
self.pb.update('cleaning up...')
412
if not self._supplied_pb:
416
class VerboseTestResult(ExtendedTestResult):
417
"""Produce long output, with one line per test run plus times"""
419
def _ellipsize_to_right(self, a_string, final_width):
420
"""Truncate and pad a string, keeping the right hand side"""
421
if len(a_string) > final_width:
422
result = '...' + a_string[3-final_width:]
425
return result.ljust(final_width)
427
def report_starting(self):
428
self.stream.write('running %d tests...\n' % self.num_tests)
430
def report_test_start(self, test):
432
name = self._shortened_test_description(test)
433
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
434
# numbers, plus a trailing blank
435
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
437
self.stream.write('%5d ' % self.count)
438
self.stream.write(self._ellipsize_to_right(name,
439
osutils.terminal_width()-36))
441
self.stream.write(self._ellipsize_to_right(name,
442
osutils.terminal_width()-30))
445
def _error_summary(self, err):
449
return '%s%s' % (indent, err[1])
451
def report_error(self, test, err):
452
self.stream.writeln('ERROR %s\n%s'
453
% (self._testTimeString(),
454
self._error_summary(err)))
456
def report_failure(self, test, err):
457
self.stream.writeln(' FAIL %s\n%s'
458
% (self._testTimeString(),
459
self._error_summary(err)))
461
def report_known_failure(self, test, err):
462
self.stream.writeln('XFAIL %s\n%s'
463
% (self._testTimeString(),
464
self._error_summary(err)))
466
def report_success(self, test):
467
self.stream.writeln(' OK %s' % self._testTimeString())
468
for bench_called, stats in getattr(test, '_benchcalls', []):
469
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
470
stats.pprint(file=self.stream)
471
# flush the stream so that we get smooth output. This verbose mode is
472
# used to show the output in PQM.
475
def report_skip(self, test, skip_excinfo):
477
self.stream.writeln(' SKIP %s\n%s'
478
% (self._testTimeString(),
479
self._error_summary(skip_excinfo)))
481
def report_unsupported(self, test, feature):
482
"""test cannot be run because feature is missing."""
483
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
484
%(self._testTimeString(), feature))
488
class TextTestRunner(object):
489
stop_on_failure = False
497
self.stream = unittest._WritelnDecorator(stream)
498
self.descriptions = descriptions
499
self.verbosity = verbosity
500
self.keep_output = keep_output
501
self._bench_history = bench_history
504
"Run the given test case or test suite."
505
startTime = time.time()
506
if self.verbosity == 1:
507
result_class = TextTestResult
508
elif self.verbosity >= 2:
509
result_class = VerboseTestResult
510
result = result_class(self.stream,
513
bench_history=self._bench_history,
514
num_tests=test.countTestCases(),
516
result.stop_early = self.stop_on_failure
517
result.report_starting()
519
stopTime = time.time()
520
timeTaken = stopTime - startTime
522
self.stream.writeln(result.separator2)
523
run = result.testsRun
524
self.stream.writeln("Ran %d test%s in %.3fs" %
525
(run, run != 1 and "s" or "", timeTaken))
526
self.stream.writeln()
527
if not result.wasSuccessful():
528
self.stream.write("FAILED (")
529
failed, errored = map(len, (result.failures, result.errors))
531
self.stream.write("failures=%d" % failed)
533
if failed: self.stream.write(", ")
534
self.stream.write("errors=%d" % errored)
535
if result.known_failure_count:
536
if failed or errored: self.stream.write(", ")
537
self.stream.write("known_failure_count=%d" %
538
result.known_failure_count)
539
self.stream.writeln(")")
541
if result.known_failure_count:
542
self.stream.writeln("OK (known_failures=%d)" %
543
result.known_failure_count)
545
self.stream.writeln("OK")
546
if result.skip_count > 0:
547
skipped = result.skip_count
548
self.stream.writeln('%d test%s skipped' %
549
(skipped, skipped != 1 and "s" or ""))
550
if result.unsupported:
551
for feature, count in sorted(result.unsupported.items()):
552
self.stream.writeln("Missing feature '%s' skipped %d tests." %
554
result.report_cleaning_up()
555
# This is still a little bogus,
556
# but only a little. Folk not using our testrunner will
557
# have to delete their temp directories themselves.
558
test_root = TestCaseWithMemoryTransport.TEST_ROOT
559
if result.wasSuccessful() or not self.keep_output:
560
if test_root is not None:
561
# If LANG=C we probably have created some bogus paths
562
# which rmtree(unicode) will fail to delete
563
# so make sure we are using rmtree(str) to delete everything
564
# except on win32, where rmtree(str) will fail
565
# since it doesn't have the property of byte-stream paths
566
# (they are either ascii or mbcs)
567
if sys.platform == 'win32':
568
# make sure we are using the unicode win32 api
569
test_root = unicode(test_root)
571
test_root = test_root.encode(
572
sys.getfilesystemencoding())
574
osutils.rmtree(test_root)
576
if sys.platform == 'win32' and e.errno == errno.EACCES:
577
print >>sys.stderr, ('Permission denied: '
578
'unable to remove testing dir '
579
'%s' % os.path.basename(test_root))
583
note("Failed tests working directories are in '%s'\n", test_root)
584
TestCaseWithMemoryTransport.TEST_ROOT = None
589
def iter_suite_tests(suite):
590
"""Return all tests in a suite, recursing through nested suites"""
591
for item in suite._tests:
592
if isinstance(item, unittest.TestCase):
594
elif isinstance(item, unittest.TestSuite):
595
for r in iter_suite_tests(item):
598
raise Exception('unknown object %r inside test suite %r'
602
class TestSkipped(Exception):
603
"""Indicates that a test was intentionally skipped, rather than failing."""
606
class KnownFailure(AssertionError):
607
"""Indicates that a test failed in a precisely expected manner.
609
Such failures dont block the whole test suite from passing because they are
610
indicators of partially completed code or of future work. We have an
611
explicit error for them so that we can ensure that they are always visible:
612
KnownFailures are always shown in the output of bzr selftest.
616
class UnavailableFeature(Exception):
617
"""A feature required for this test was not available.
619
The feature should be used to construct the exception.
623
class CommandFailed(Exception):
627
class StringIOWrapper(object):
628
"""A wrapper around cStringIO which just adds an encoding attribute.
630
Internally we can check sys.stdout to see what the output encoding
631
should be. However, cStringIO has no encoding attribute that we can
632
set. So we wrap it instead.
637
def __init__(self, s=None):
639
self.__dict__['_cstring'] = StringIO(s)
641
self.__dict__['_cstring'] = StringIO()
643
def __getattr__(self, name, getattr=getattr):
644
return getattr(self.__dict__['_cstring'], name)
646
def __setattr__(self, name, val):
647
if name == 'encoding':
648
self.__dict__['encoding'] = val
650
return setattr(self._cstring, name, val)
653
class TestUIFactory(ui.CLIUIFactory):
654
"""A UI Factory for testing.
656
Hide the progress bar but emit note()s.
658
Allows get_password to be tested without real tty attached.
665
super(TestUIFactory, self).__init__()
666
if stdin is not None:
667
# We use a StringIOWrapper to be able to test various
668
# encodings, but the user is still responsible to
669
# encode the string and to set the encoding attribute
670
# of StringIOWrapper.
671
self.stdin = StringIOWrapper(stdin)
673
self.stdout = sys.stdout
677
self.stderr = sys.stderr
682
"""See progress.ProgressBar.clear()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
687
def clear_term(self):
688
"""See progress.ProgressBar.clear_term()."""
691
"""See progress.ProgressBar.finished()."""
693
def note(self, fmt_string, *args, **kwargs):
694
"""See progress.ProgressBar.note()."""
695
self.stdout.write((fmt_string + "\n") % args)
697
def progress_bar(self):
700
def nested_progress_bar(self):
703
def update(self, message, count=None, total=None):
704
"""See progress.ProgressBar.update()."""
706
def get_non_echoed_password(self, prompt):
707
"""Get password from stdin without trying to handle the echo mode"""
709
self.stdout.write(prompt)
710
password = self.stdin.readline()
713
if password[-1] == '\n':
714
password = password[:-1]
718
class TestCase(unittest.TestCase):
719
"""Base class for bzr unit tests.
721
Tests that need access to disk resources should subclass
722
TestCaseInTempDir not TestCase.
724
Error and debug log messages are redirected from their usual
725
location into a temporary file, the contents of which can be
726
retrieved by _get_log(). We use a real OS file, not an in-memory object,
727
so that it can also capture file IO. When the test completes this file
728
is read into memory and removed from disk.
730
There are also convenience functions to invoke bzr's command-line
731
routine, and to build and check bzr trees.
733
In addition to the usual method of overriding tearDown(), this class also
734
allows subclasses to register functions into the _cleanups list, which is
735
run in order as the object is torn down. It's less likely this will be
736
accidentally overlooked.
739
_log_file_name = None
741
_keep_log_file = False
742
# record lsprof data when performing benchmark calls.
743
_gather_lsprof_in_benchmarks = False
745
def __init__(self, methodName='testMethod'):
746
super(TestCase, self).__init__(methodName)
750
unittest.TestCase.setUp(self)
751
self._cleanEnvironment()
752
bzrlib.trace.disable_default_logging()
755
self._benchcalls = []
756
self._benchtime = None
757
# prevent hooks affecting tests
758
self._preserved_hooks = bzrlib.branch.Branch.hooks
759
self.addCleanup(self._restoreHooks)
760
# this list of hooks must be kept in sync with the defaults
762
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
764
def _silenceUI(self):
765
"""Turn off UI for duration of test"""
766
# by default the UI is off; tests can turn it on if they want it.
767
saved = ui.ui_factory
769
ui.ui_factory = saved
770
ui.ui_factory = ui.SilentUIFactory()
771
self.addCleanup(_restore)
773
def _ndiff_strings(self, a, b):
774
"""Return ndiff between two strings containing lines.
776
A trailing newline is added if missing to make the strings
778
if b and b[-1] != '\n':
780
if a and a[-1] != '\n':
782
difflines = difflib.ndiff(a.splitlines(True),
784
linejunk=lambda x: False,
785
charjunk=lambda x: False)
786
return ''.join(difflines)
788
def assertEqual(self, a, b, message=''):
792
except UnicodeError, e:
793
# If we can't compare without getting a UnicodeError, then
794
# obviously they are different
795
mutter('UnicodeError: %s', e)
798
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
800
pformat(a, indent=4), pformat(b, indent=4)))
802
assertEquals = assertEqual
804
def assertEqualDiff(self, a, b, message=None):
805
"""Assert two texts are equal, if not raise an exception.
807
This is intended for use with multi-line strings where it can
808
be hard to find the differences by eye.
810
# TODO: perhaps override assertEquals to call this for strings?
814
message = "texts not equal:\n"
815
raise AssertionError(message +
816
self._ndiff_strings(a, b))
818
def assertEqualMode(self, mode, mode_test):
819
self.assertEqual(mode, mode_test,
820
'mode mismatch %o != %o' % (mode, mode_test))
822
def assertStartsWith(self, s, prefix):
823
if not s.startswith(prefix):
824
raise AssertionError('string %r does not start with %r' % (s, prefix))
826
def assertEndsWith(self, s, suffix):
827
"""Asserts that s ends with suffix."""
828
if not s.endswith(suffix):
829
raise AssertionError('string %r does not end with %r' % (s, suffix))
831
def assertContainsRe(self, haystack, needle_re):
832
"""Assert that a contains something matching a regular expression."""
833
if not re.search(needle_re, haystack):
834
raise AssertionError('pattern "%r" not found in "%r"'
835
% (needle_re, haystack))
837
def assertNotContainsRe(self, haystack, needle_re):
838
"""Assert that a does not match a regular expression"""
839
if re.search(needle_re, haystack):
840
raise AssertionError('pattern "%s" found in "%s"'
841
% (needle_re, haystack))
843
def assertSubset(self, sublist, superlist):
844
"""Assert that every entry in sublist is present in superlist."""
846
for entry in sublist:
847
if entry not in superlist:
848
missing.append(entry)
850
raise AssertionError("value(s) %r not present in container %r" %
851
(missing, superlist))
853
def assertListRaises(self, excClass, func, *args, **kwargs):
854
"""Fail unless excClass is raised when the iterator from func is used.
856
Many functions can return generators this makes sure
857
to wrap them in a list() call to make sure the whole generator
858
is run, and that the proper exception is raised.
861
list(func(*args, **kwargs))
865
if getattr(excClass,'__name__', None) is not None:
866
excName = excClass.__name__
868
excName = str(excClass)
869
raise self.failureException, "%s not raised" % excName
871
def assertRaises(self, excClass, func, *args, **kwargs):
872
"""Assert that a callable raises a particular exception.
874
:param excClass: As for the except statement, this may be either an
875
exception class, or a tuple of classes.
877
Returns the exception so that you can examine it.
880
func(*args, **kwargs)
884
if getattr(excClass,'__name__', None) is not None:
885
excName = excClass.__name__
888
excName = str(excClass)
889
raise self.failureException, "%s not raised" % excName
891
def assertIs(self, left, right, message=None):
892
if not (left is right):
893
if message is not None:
894
raise AssertionError(message)
896
raise AssertionError("%r is not %r." % (left, right))
898
def assertIsNot(self, left, right, message=None):
900
if message is not None:
901
raise AssertionError(message)
903
raise AssertionError("%r is %r." % (left, right))
905
def assertTransportMode(self, transport, path, mode):
906
"""Fail if a path does not have mode mode.
908
If modes are not supported on this transport, the assertion is ignored.
910
if not transport._can_roundtrip_unix_modebits():
912
path_stat = transport.stat(path)
913
actual_mode = stat.S_IMODE(path_stat.st_mode)
914
self.assertEqual(mode, actual_mode,
915
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
917
def assertIsInstance(self, obj, kls):
918
"""Fail if obj is not an instance of kls"""
919
if not isinstance(obj, kls):
920
self.fail("%r is an instance of %s rather than %s" % (
921
obj, obj.__class__, kls))
923
def expectFailure(self, reason, assertion, *args, **kwargs):
924
"""Invoke a test, expecting it to fail for the given reason.
926
This is for assertions that ought to succeed, but currently fail.
927
(The failure is *expected* but not *wanted*.) Please be very precise
928
about the failure you're expecting. If a new bug is introduced,
929
AssertionError should be raised, not KnownFailure.
931
Frequently, expectFailure should be followed by an opposite assertion.
934
Intended to be used with a callable that raises AssertionError as the
935
'assertion' parameter. args and kwargs are passed to the 'assertion'.
937
Raises KnownFailure if the test fails. Raises AssertionError if the
942
self.expectFailure('Math is broken', self.assertNotEqual, 54,
944
self.assertEqual(42, dynamic_val)
946
This means that a dynamic_val of 54 will cause the test to raise
947
a KnownFailure. Once math is fixed and the expectFailure is removed,
948
only a dynamic_val of 42 will allow the test to pass. Anything other
949
than 54 or 42 will cause an AssertionError.
952
assertion(*args, **kwargs)
953
except AssertionError:
954
raise KnownFailure(reason)
956
self.fail('Unexpected success. Should have failed: %s' % reason)
958
def _capture_warnings(self, a_callable, *args, **kwargs):
959
"""A helper for callDeprecated and applyDeprecated.
961
:param a_callable: A callable to call.
962
:param args: The positional arguments for the callable
963
:param kwargs: The keyword arguments for the callable
964
:return: A tuple (warnings, result). result is the result of calling
965
a_callable(*args, **kwargs).
968
def capture_warnings(msg, cls=None, stacklevel=None):
969
# we've hooked into a deprecation specific callpath,
970
# only deprecations should getting sent via it.
971
self.assertEqual(cls, DeprecationWarning)
972
local_warnings.append(msg)
973
original_warning_method = symbol_versioning.warn
974
symbol_versioning.set_warning_method(capture_warnings)
976
result = a_callable(*args, **kwargs)
978
symbol_versioning.set_warning_method(original_warning_method)
979
return (local_warnings, result)
981
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
982
"""Call a deprecated callable without warning the user.
984
:param deprecation_format: The deprecation format that the callable
985
should have been deprecated with. This is the same type as the
986
parameter to deprecated_method/deprecated_function. If the
987
callable is not deprecated with this format, an assertion error
989
:param a_callable: A callable to call. This may be a bound method or
990
a regular function. It will be called with *args and **kwargs.
991
:param args: The positional arguments for the callable
992
:param kwargs: The keyword arguments for the callable
993
:return: The result of a_callable(*args, **kwargs)
995
call_warnings, result = self._capture_warnings(a_callable,
997
expected_first_warning = symbol_versioning.deprecation_string(
998
a_callable, deprecation_format)
999
if len(call_warnings) == 0:
1000
self.fail("No deprecation warning generated by call to %s" %
1002
self.assertEqual(expected_first_warning, call_warnings[0])
1005
def callDeprecated(self, expected, callable, *args, **kwargs):
1006
"""Assert that a callable is deprecated in a particular way.
1008
This is a very precise test for unusual requirements. The
1009
applyDeprecated helper function is probably more suited for most tests
1010
as it allows you to simply specify the deprecation format being used
1011
and will ensure that that is issued for the function being called.
1013
:param expected: a list of the deprecation warnings expected, in order
1014
:param callable: The callable to call
1015
:param args: The positional arguments for the callable
1016
:param kwargs: The keyword arguments for the callable
1018
call_warnings, result = self._capture_warnings(callable,
1020
self.assertEqual(expected, call_warnings)
1023
def _startLogFile(self):
1024
"""Send bzr and test log messages to a temporary file.
1026
The file is removed as the test is torn down.
1028
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1029
self._log_file = os.fdopen(fileno, 'w+')
1030
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1031
self._log_file_name = name
1032
self.addCleanup(self._finishLogFile)
1034
def _finishLogFile(self):
1035
"""Finished with the log file.
1037
Close the file and delete it, unless setKeepLogfile was called.
1039
if self._log_file is None:
1041
bzrlib.trace.disable_test_log(self._log_nonce)
1042
self._log_file.close()
1043
self._log_file = None
1044
if not self._keep_log_file:
1045
os.remove(self._log_file_name)
1046
self._log_file_name = None
1048
def setKeepLogfile(self):
1049
"""Make the logfile not be deleted when _finishLogFile is called."""
1050
self._keep_log_file = True
1052
def addCleanup(self, callable):
1053
"""Arrange to run a callable when this case is torn down.
1055
Callables are run in the reverse of the order they are registered,
1056
ie last-in first-out.
1058
if callable in self._cleanups:
1059
raise ValueError("cleanup function %r already registered on %s"
1061
self._cleanups.append(callable)
1063
def _cleanEnvironment(self):
1065
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1066
'HOME': os.getcwd(),
1067
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1069
'BZREMAIL': None, # may still be present in the environment
1071
'BZR_PROGRESS_BAR': None,
1075
'https_proxy': None,
1076
'HTTPS_PROXY': None,
1081
# Nobody cares about these ones AFAIK. So far at
1082
# least. If you do (care), please update this comment
1088
self.addCleanup(self._restoreEnvironment)
1089
for name, value in new_env.iteritems():
1090
self._captureVar(name, value)
1092
def _captureVar(self, name, newvalue):
1093
"""Set an environment variable, and reset it when finished."""
1094
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1096
def _restoreEnvironment(self):
1097
for name, value in self.__old_env.iteritems():
1098
osutils.set_or_unset_env(name, value)
1100
def _restoreHooks(self):
1101
bzrlib.branch.Branch.hooks = self._preserved_hooks
1103
def knownFailure(self, reason):
1104
"""This test has failed for some known reason."""
1105
raise KnownFailure(reason)
1107
def run(self, result=None):
1108
if result is None: result = self.defaultTestResult()
1109
for feature in getattr(self, '_test_needs_features', []):
1110
if not feature.available():
1111
result.startTest(self)
1112
if getattr(result, 'addNotSupported', None):
1113
result.addNotSupported(self, feature)
1115
result.addSuccess(self)
1116
result.stopTest(self)
1118
return unittest.TestCase.run(self, result)
1122
unittest.TestCase.tearDown(self)
1124
def time(self, callable, *args, **kwargs):
1125
"""Run callable and accrue the time it takes to the benchmark time.
1127
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1128
this will cause lsprofile statistics to be gathered and stored in
1131
if self._benchtime is None:
1135
if not self._gather_lsprof_in_benchmarks:
1136
return callable(*args, **kwargs)
1138
# record this benchmark
1139
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1141
self._benchcalls.append(((callable, args, kwargs), stats))
1144
self._benchtime += time.time() - start
1146
def _runCleanups(self):
1147
"""Run registered cleanup functions.
1149
This should only be called from TestCase.tearDown.
1151
# TODO: Perhaps this should keep running cleanups even if
1152
# one of them fails?
1154
# Actually pop the cleanups from the list so tearDown running
1155
# twice is safe (this happens for skipped tests).
1156
while self._cleanups:
1157
self._cleanups.pop()()
1159
def log(self, *args):
1162
def _get_log(self, keep_log_file=False):
1163
"""Return as a string the log for this test. If the file is still
1164
on disk and keep_log_file=False, delete the log file and store the
1165
content in self._log_contents."""
1166
# flush the log file, to get all content
1168
bzrlib.trace._trace_file.flush()
1169
if self._log_contents:
1170
return self._log_contents
1171
if self._log_file_name is not None:
1172
logfile = open(self._log_file_name)
1174
log_contents = logfile.read()
1177
if not keep_log_file:
1178
self._log_contents = log_contents
1180
os.remove(self._log_file_name)
1182
if sys.platform == 'win32' and e.errno == errno.EACCES:
1183
print >>sys.stderr, ('Unable to delete log file '
1184
' %r' % self._log_file_name)
1189
return "DELETED log file to reduce memory footprint"
1191
def capture(self, cmd, retcode=0):
1192
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1193
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1195
def requireFeature(self, feature):
1196
"""This test requires a specific feature is available.
1198
:raises UnavailableFeature: When feature is not available.
1200
if not feature.available():
1201
raise UnavailableFeature(feature)
1203
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1205
"""Invoke bzr and return (stdout, stderr).
1207
Useful for code that wants to check the contents of the
1208
output, the way error messages are presented, etc.
1210
This should be the main method for tests that want to exercise the
1211
overall behavior of the bzr application (rather than a unit test
1212
or a functional test of the library.)
1214
Much of the old code runs bzr by forking a new copy of Python, but
1215
that is slower, harder to debug, and generally not necessary.
1217
This runs bzr through the interface that catches and reports
1218
errors, and with logging set to something approximating the
1219
default, so that error reporting can be checked.
1221
:param argv: arguments to invoke bzr
1222
:param retcode: expected return code, or None for don't-care.
1223
:param encoding: encoding for sys.stdout and sys.stderr
1224
:param stdin: A string to be used as stdin for the command.
1225
:param working_dir: Change to this directory before running
1227
if encoding is None:
1228
encoding = bzrlib.user_encoding
1229
stdout = StringIOWrapper()
1230
stderr = StringIOWrapper()
1231
stdout.encoding = encoding
1232
stderr.encoding = encoding
1234
self.log('run bzr: %r', argv)
1235
# FIXME: don't call into logging here
1236
handler = logging.StreamHandler(stderr)
1237
handler.setLevel(logging.INFO)
1238
logger = logging.getLogger('')
1239
logger.addHandler(handler)
1240
old_ui_factory = ui.ui_factory
1241
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1244
if working_dir is not None:
1245
cwd = osutils.getcwd()
1246
os.chdir(working_dir)
1249
saved_debug_flags = frozenset(debug.debug_flags)
1250
debug.debug_flags.clear()
1252
result = self.apply_redirected(ui.ui_factory.stdin,
1254
bzrlib.commands.run_bzr_catch_errors,
1257
debug.debug_flags.update(saved_debug_flags)
1259
logger.removeHandler(handler)
1260
ui.ui_factory = old_ui_factory
1264
out = stdout.getvalue()
1265
err = stderr.getvalue()
1267
self.log('output:\n%r', out)
1269
self.log('errors:\n%r', err)
1270
if retcode is not None:
1271
self.assertEquals(retcode, result)
1274
def run_bzr(self, *args, **kwargs):
1275
"""Invoke bzr, as if it were run from the command line.
1277
This should be the main method for tests that want to exercise the
1278
overall behavior of the bzr application (rather than a unit test
1279
or a functional test of the library.)
1281
This sends the stdout/stderr results into the test's log,
1282
where it may be useful for debugging. See also run_captured.
1284
:param stdin: A string to be used as stdin for the command.
1285
:param retcode: The status code the command should return
1286
:param working_dir: The directory to run the command in
1288
retcode = kwargs.pop('retcode', 0)
1289
encoding = kwargs.pop('encoding', None)
1290
stdin = kwargs.pop('stdin', None)
1291
working_dir = kwargs.pop('working_dir', None)
1292
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1293
stdin=stdin, working_dir=working_dir)
1295
def run_bzr_decode(self, *args, **kwargs):
1296
if 'encoding' in kwargs:
1297
encoding = kwargs['encoding']
1299
encoding = bzrlib.user_encoding
1300
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1302
def run_bzr_error(self, error_regexes, *args, **kwargs):
1303
"""Run bzr, and check that stderr contains the supplied regexes
1305
:param error_regexes: Sequence of regular expressions which
1306
must each be found in the error output. The relative ordering
1308
:param args: command-line arguments for bzr
1309
:param kwargs: Keyword arguments which are interpreted by run_bzr
1310
This function changes the default value of retcode to be 3,
1311
since in most cases this is run when you expect bzr to fail.
1312
:return: (out, err) The actual output of running the command (in case you
1313
want to do more inspection)
1316
# Make sure that commit is failing because there is nothing to do
1317
self.run_bzr_error(['no changes to commit'],
1318
'commit', '-m', 'my commit comment')
1319
# Make sure --strict is handling an unknown file, rather than
1320
# giving us the 'nothing to do' error
1321
self.build_tree(['unknown'])
1322
self.run_bzr_error(['Commit refused because there are unknown files'],
1323
'commit', '--strict', '-m', 'my commit comment')
1325
kwargs.setdefault('retcode', 3)
1326
out, err = self.run_bzr(*args, **kwargs)
1327
for regex in error_regexes:
1328
self.assertContainsRe(err, regex)
1331
def run_bzr_subprocess(self, *args, **kwargs):
1332
"""Run bzr in a subprocess for testing.
1334
This starts a new Python interpreter and runs bzr in there.
1335
This should only be used for tests that have a justifiable need for
1336
this isolation: e.g. they are testing startup time, or signal
1337
handling, or early startup code, etc. Subprocess code can't be
1338
profiled or debugged so easily.
1340
:param retcode: The status code that is expected. Defaults to 0. If
1341
None is supplied, the status code is not checked.
1342
:param env_changes: A dictionary which lists changes to environment
1343
variables. A value of None will unset the env variable.
1344
The values must be strings. The change will only occur in the
1345
child, so you don't need to fix the environment after running.
1346
:param universal_newlines: Convert CRLF => LF
1347
:param allow_plugins: By default the subprocess is run with
1348
--no-plugins to ensure test reproducibility. Also, it is possible
1349
for system-wide plugins to create unexpected output on stderr,
1350
which can cause unnecessary test failures.
1352
env_changes = kwargs.get('env_changes', {})
1353
working_dir = kwargs.get('working_dir', None)
1354
allow_plugins = kwargs.get('allow_plugins', False)
1355
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1356
working_dir=working_dir,
1357
allow_plugins=allow_plugins)
1358
# We distinguish between retcode=None and retcode not passed.
1359
supplied_retcode = kwargs.get('retcode', 0)
1360
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1361
universal_newlines=kwargs.get('universal_newlines', False),
1364
def start_bzr_subprocess(self, process_args, env_changes=None,
1365
skip_if_plan_to_signal=False,
1367
allow_plugins=False):
1368
"""Start bzr in a subprocess for testing.
1370
This starts a new Python interpreter and runs bzr in there.
1371
This should only be used for tests that have a justifiable need for
1372
this isolation: e.g. they are testing startup time, or signal
1373
handling, or early startup code, etc. Subprocess code can't be
1374
profiled or debugged so easily.
1376
:param process_args: a list of arguments to pass to the bzr executable,
1377
for example `['--version']`.
1378
:param env_changes: A dictionary which lists changes to environment
1379
variables. A value of None will unset the env variable.
1380
The values must be strings. The change will only occur in the
1381
child, so you don't need to fix the environment after running.
1382
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1384
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1386
:returns: Popen object for the started process.
1388
if skip_if_plan_to_signal:
1389
if not getattr(os, 'kill', None):
1390
raise TestSkipped("os.kill not available.")
1392
if env_changes is None:
1396
def cleanup_environment():
1397
for env_var, value in env_changes.iteritems():
1398
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1400
def restore_environment():
1401
for env_var, value in old_env.iteritems():
1402
osutils.set_or_unset_env(env_var, value)
1404
bzr_path = self.get_bzr_path()
1407
if working_dir is not None:
1408
cwd = osutils.getcwd()
1409
os.chdir(working_dir)
1412
# win32 subprocess doesn't support preexec_fn
1413
# so we will avoid using it on all platforms, just to
1414
# make sure the code path is used, and we don't break on win32
1415
cleanup_environment()
1416
command = [sys.executable, bzr_path]
1417
if not allow_plugins:
1418
command.append('--no-plugins')
1419
command.extend(process_args)
1420
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1422
restore_environment()
1428
def _popen(self, *args, **kwargs):
1429
"""Place a call to Popen.
1431
Allows tests to override this method to intercept the calls made to
1432
Popen for introspection.
1434
return Popen(*args, **kwargs)
1436
def get_bzr_path(self):
1437
"""Return the path of the 'bzr' executable for this test suite."""
1438
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1439
if not os.path.isfile(bzr_path):
1440
# We are probably installed. Assume sys.argv is the right file
1441
bzr_path = sys.argv[0]
1444
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1445
universal_newlines=False, process_args=None):
1446
"""Finish the execution of process.
1448
:param process: the Popen object returned from start_bzr_subprocess.
1449
:param retcode: The status code that is expected. Defaults to 0. If
1450
None is supplied, the status code is not checked.
1451
:param send_signal: an optional signal to send to the process.
1452
:param universal_newlines: Convert CRLF => LF
1453
:returns: (stdout, stderr)
1455
if send_signal is not None:
1456
os.kill(process.pid, send_signal)
1457
out, err = process.communicate()
1459
if universal_newlines:
1460
out = out.replace('\r\n', '\n')
1461
err = err.replace('\r\n', '\n')
1463
if retcode is not None and retcode != process.returncode:
1464
if process_args is None:
1465
process_args = "(unknown args)"
1466
mutter('Output of bzr %s:\n%s', process_args, out)
1467
mutter('Error for bzr %s:\n%s', process_args, err)
1468
self.fail('Command bzr %s failed with retcode %s != %s'
1469
% (process_args, retcode, process.returncode))
1472
def check_inventory_shape(self, inv, shape):
1473
"""Compare an inventory to a list of expected names.
1475
Fail if they are not precisely equal.
1478
shape = list(shape) # copy
1479
for path, ie in inv.entries():
1480
name = path.replace('\\', '/')
1481
if ie.kind == 'dir':
1488
self.fail("expected paths not found in inventory: %r" % shape)
1490
self.fail("unexpected paths found in inventory: %r" % extras)
1492
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1493
a_callable=None, *args, **kwargs):
1494
"""Call callable with redirected std io pipes.
1496
Returns the return code."""
1497
if not callable(a_callable):
1498
raise ValueError("a_callable must be callable.")
1500
stdin = StringIO("")
1502
if getattr(self, "_log_file", None) is not None:
1503
stdout = self._log_file
1507
if getattr(self, "_log_file", None is not None):
1508
stderr = self._log_file
1511
real_stdin = sys.stdin
1512
real_stdout = sys.stdout
1513
real_stderr = sys.stderr
1518
return a_callable(*args, **kwargs)
1520
sys.stdout = real_stdout
1521
sys.stderr = real_stderr
1522
sys.stdin = real_stdin
1524
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1525
def merge(self, branch_from, wt_to):
1526
"""A helper for tests to do a ui-less merge.
1528
This should move to the main library when someone has time to integrate
1531
# minimal ui-less merge.
1532
wt_to.branch.fetch(branch_from)
1533
base_rev = common_ancestor(branch_from.last_revision(),
1534
wt_to.branch.last_revision(),
1535
wt_to.branch.repository)
1536
merge_inner(wt_to.branch, branch_from.basis_tree(),
1537
wt_to.branch.repository.revision_tree(base_rev),
1539
wt_to.add_parent_tree_id(branch_from.last_revision())
1541
def reduceLockdirTimeout(self):
1542
"""Reduce the default lock timeout for the duration of the test, so that
1543
if LockContention occurs during a test, it does so quickly.
1545
Tests that expect to provoke LockContention errors should call this.
1547
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1549
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1550
self.addCleanup(resetTimeout)
1551
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1553
BzrTestBase = TestCase
1556
class TestCaseWithMemoryTransport(TestCase):
1557
"""Common test class for tests that do not need disk resources.
1559
Tests that need disk resources should derive from TestCaseWithTransport.
1561
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1563
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1564
a directory which does not exist. This serves to help ensure test isolation
1565
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1566
must exist. However, TestCaseWithMemoryTransport does not offer local
1567
file defaults for the transport in tests, nor does it obey the command line
1568
override, so tests that accidentally write to the common directory should
1576
def __init__(self, methodName='runTest'):
1577
# allow test parameterisation after test construction and before test
1578
# execution. Variables that the parameteriser sets need to be
1579
# ones that are not set by setUp, or setUp will trash them.
1580
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1581
self.vfs_transport_factory = default_transport
1582
self.transport_server = None
1583
self.transport_readonly_server = None
1584
self.__vfs_server = None
1586
def get_transport(self):
1587
"""Return a writeable transport for the test scratch space"""
1588
t = get_transport(self.get_url())
1589
self.assertFalse(t.is_readonly())
1592
def get_readonly_transport(self):
1593
"""Return a readonly transport for the test scratch space
1595
This can be used to test that operations which should only need
1596
readonly access in fact do not try to write.
1598
t = get_transport(self.get_readonly_url())
1599
self.assertTrue(t.is_readonly())
1602
def create_transport_readonly_server(self):
1603
"""Create a transport server from class defined at init.
1605
This is mostly a hook for daughter classes.
1607
return self.transport_readonly_server()
1609
def get_readonly_server(self):
1610
"""Get the server instance for the readonly transport
1612
This is useful for some tests with specific servers to do diagnostics.
1614
if self.__readonly_server is None:
1615
if self.transport_readonly_server is None:
1616
# readonly decorator requested
1617
# bring up the server
1618
self.__readonly_server = ReadonlyServer()
1619
self.__readonly_server.setUp(self.get_vfs_only_server())
1621
self.__readonly_server = self.create_transport_readonly_server()
1622
self.__readonly_server.setUp(self.get_vfs_only_server())
1623
self.addCleanup(self.__readonly_server.tearDown)
1624
return self.__readonly_server
1626
def get_readonly_url(self, relpath=None):
1627
"""Get a URL for the readonly transport.
1629
This will either be backed by '.' or a decorator to the transport
1630
used by self.get_url()
1631
relpath provides for clients to get a path relative to the base url.
1632
These should only be downwards relative, not upwards.
1634
base = self.get_readonly_server().get_url()
1635
if relpath is not None:
1636
if not base.endswith('/'):
1638
base = base + relpath
1641
def get_vfs_only_server(self):
1642
"""Get the vfs only read/write server instance.
1644
This is useful for some tests with specific servers that need
1647
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1648
is no means to override it.
1650
if self.__vfs_server is None:
1651
self.__vfs_server = MemoryServer()
1652
self.__vfs_server.setUp()
1653
self.addCleanup(self.__vfs_server.tearDown)
1654
return self.__vfs_server
1656
def get_server(self):
1657
"""Get the read/write server instance.
1659
This is useful for some tests with specific servers that need
1662
This is built from the self.transport_server factory. If that is None,
1663
then the self.get_vfs_server is returned.
1665
if self.__server is None:
1666
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1667
return self.get_vfs_only_server()
1669
# bring up a decorated means of access to the vfs only server.
1670
self.__server = self.transport_server()
1672
self.__server.setUp(self.get_vfs_only_server())
1673
except TypeError, e:
1674
# This should never happen; the try:Except here is to assist
1675
# developers having to update code rather than seeing an
1676
# uninformative TypeError.
1677
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1678
self.addCleanup(self.__server.tearDown)
1679
return self.__server
1681
def _adjust_url(self, base, relpath):
1682
"""Get a URL (or maybe a path) for the readwrite transport.
1684
This will either be backed by '.' or to an equivalent non-file based
1686
relpath provides for clients to get a path relative to the base url.
1687
These should only be downwards relative, not upwards.
1689
if relpath is not None and relpath != '.':
1690
if not base.endswith('/'):
1692
# XXX: Really base should be a url; we did after all call
1693
# get_url()! But sometimes it's just a path (from
1694
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1695
# to a non-escaped local path.
1696
if base.startswith('./') or base.startswith('/'):
1699
base += urlutils.escape(relpath)
1702
def get_url(self, relpath=None):
1703
"""Get a URL (or maybe a path) for the readwrite transport.
1705
This will either be backed by '.' or to an equivalent non-file based
1707
relpath provides for clients to get a path relative to the base url.
1708
These should only be downwards relative, not upwards.
1710
base = self.get_server().get_url()
1711
return self._adjust_url(base, relpath)
1713
def get_vfs_only_url(self, relpath=None):
1714
"""Get a URL (or maybe a path for the plain old vfs transport.
1716
This will never be a smart protocol.
1717
:param relpath: provides for clients to get a path relative to the base
1718
url. These should only be downwards relative, not upwards.
1720
base = self.get_vfs_only_server().get_url()
1721
return self._adjust_url(base, relpath)
1723
def _make_test_root(self):
1724
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1728
root = u'test%04d.tmp' % i
1732
if e.errno == errno.EEXIST:
1737
# successfully created
1738
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1740
# make a fake bzr directory there to prevent any tests propagating
1741
# up onto the source directory's real branch
1742
bzrdir.BzrDir.create_standalone_workingtree(
1743
TestCaseWithMemoryTransport.TEST_ROOT)
1745
def makeAndChdirToTestDir(self):
1746
"""Create a temporary directories for this one test.
1748
This must set self.test_home_dir and self.test_dir and chdir to
1751
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1753
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1754
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1755
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1757
def make_branch(self, relpath, format=None):
1758
"""Create a branch on the transport at relpath."""
1759
repo = self.make_repository(relpath, format=format)
1760
return repo.bzrdir.create_branch()
1762
def make_bzrdir(self, relpath, format=None):
1764
# might be a relative or absolute path
1765
maybe_a_url = self.get_url(relpath)
1766
segments = maybe_a_url.rsplit('/', 1)
1767
t = get_transport(maybe_a_url)
1768
if len(segments) > 1 and segments[-1] not in ('', '.'):
1771
except errors.FileExists:
1775
if isinstance(format, basestring):
1776
format = bzrdir.format_registry.make_bzrdir(format)
1777
return format.initialize_on_transport(t)
1778
except errors.UninitializableFormat:
1779
raise TestSkipped("Format %s is not initializable." % format)
1781
def make_repository(self, relpath, shared=False, format=None):
1782
"""Create a repository on our default transport at relpath."""
1783
made_control = self.make_bzrdir(relpath, format=format)
1784
return made_control.create_repository(shared=shared)
1786
def make_branch_and_memory_tree(self, relpath, format=None):
1787
"""Create a branch on the default transport and a MemoryTree for it."""
1788
b = self.make_branch(relpath, format=format)
1789
return memorytree.MemoryTree.create_on_branch(b)
1791
def overrideEnvironmentForTesting(self):
1792
os.environ['HOME'] = self.test_home_dir
1793
os.environ['BZR_HOME'] = self.test_home_dir
1796
super(TestCaseWithMemoryTransport, self).setUp()
1797
self._make_test_root()
1798
_currentdir = os.getcwdu()
1799
def _leaveDirectory():
1800
os.chdir(_currentdir)
1801
self.addCleanup(_leaveDirectory)
1802
self.makeAndChdirToTestDir()
1803
self.overrideEnvironmentForTesting()
1804
self.__readonly_server = None
1805
self.__server = None
1806
self.reduceLockdirTimeout()
1809
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1810
"""Derived class that runs a test within a temporary directory.
1812
This is useful for tests that need to create a branch, etc.
1814
The directory is created in a slightly complex way: for each
1815
Python invocation, a new temporary top-level directory is created.
1816
All test cases create their own directory within that. If the
1817
tests complete successfully, the directory is removed.
1819
InTempDir is an old alias for FunctionalTestCase.
1822
OVERRIDE_PYTHON = 'python'
1824
def check_file_contents(self, filename, expect):
1825
self.log("check contents of file %s" % filename)
1826
contents = file(filename, 'r').read()
1827
if contents != expect:
1828
self.log("expected: %r" % expect)
1829
self.log("actually: %r" % contents)
1830
self.fail("contents of %s not as expected" % filename)
1832
def makeAndChdirToTestDir(self):
1833
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1835
For TestCaseInTempDir we create a temporary directory based on the test
1836
name and then create two subdirs - test and home under it.
1838
if NUMBERED_DIRS: # strongly recommended on Windows
1839
# due the path length limitation (260 chars)
1840
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1841
int(self.number/1000),
1843
os.makedirs(candidate_dir)
1844
self.test_home_dir = candidate_dir + '/home'
1845
os.mkdir(self.test_home_dir)
1846
self.test_dir = candidate_dir + '/work'
1847
os.mkdir(self.test_dir)
1848
os.chdir(self.test_dir)
1849
# put name of test inside
1850
f = file(candidate_dir + '/name', 'w')
1855
# shorten the name, to avoid test failures due to path length
1856
short_id = self.id().replace('bzrlib.tests.', '') \
1857
.replace('__main__.', '')[-100:]
1858
# it's possible the same test class is run several times for
1859
# parameterized tests, so make sure the names don't collide.
1863
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1865
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1866
if os.path.exists(candidate_dir):
1870
os.mkdir(candidate_dir)
1871
self.test_home_dir = candidate_dir + '/home'
1872
os.mkdir(self.test_home_dir)
1873
self.test_dir = candidate_dir + '/work'
1874
os.mkdir(self.test_dir)
1875
os.chdir(self.test_dir)
1878
def build_tree(self, shape, line_endings='binary', transport=None):
1879
"""Build a test tree according to a pattern.
1881
shape is a sequence of file specifications. If the final
1882
character is '/', a directory is created.
1884
This assumes that all the elements in the tree being built are new.
1886
This doesn't add anything to a branch.
1887
:param line_endings: Either 'binary' or 'native'
1888
in binary mode, exact contents are written
1889
in native mode, the line endings match the
1890
default platform endings.
1892
:param transport: A transport to write to, for building trees on
1893
VFS's. If the transport is readonly or None,
1894
"." is opened automatically.
1896
# It's OK to just create them using forward slashes on windows.
1897
if transport is None or transport.is_readonly():
1898
transport = get_transport(".")
1900
self.assert_(isinstance(name, basestring))
1902
transport.mkdir(urlutils.escape(name[:-1]))
1904
if line_endings == 'binary':
1906
elif line_endings == 'native':
1909
raise errors.BzrError(
1910
'Invalid line ending request %r' % line_endings)
1911
content = "contents of %s%s" % (name.encode('utf-8'), end)
1912
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1914
def build_tree_contents(self, shape):
1915
build_tree_contents(shape)
1917
def assertFileEqual(self, content, path):
1918
"""Fail if path does not contain 'content'."""
1919
self.failUnlessExists(path)
1920
# TODO: jam 20060427 Shouldn't this be 'rb'?
1926
self.assertEqualDiff(content, s)
1928
def failUnlessExists(self, path):
1929
"""Fail unless path, which may be abs or relative, exists."""
1930
self.failUnless(osutils.lexists(path),path+" does not exist")
1932
def failIfExists(self, path):
1933
"""Fail if path, which may be abs or relative, exists."""
1934
self.failIf(osutils.lexists(path),path+" exists")
1937
class TestCaseWithTransport(TestCaseInTempDir):
1938
"""A test case that provides get_url and get_readonly_url facilities.
1940
These back onto two transport servers, one for readonly access and one for
1943
If no explicit class is provided for readonly access, a
1944
ReadonlyTransportDecorator is used instead which allows the use of non disk
1945
based read write transports.
1947
If an explicit class is provided for readonly access, that server and the
1948
readwrite one must both define get_url() as resolving to os.getcwd().
1951
def get_vfs_only_server(self):
1952
"""See TestCaseWithMemoryTransport.
1954
This is useful for some tests with specific servers that need
1957
if self.__vfs_server is None:
1958
self.__vfs_server = self.vfs_transport_factory()
1959
self.__vfs_server.setUp()
1960
self.addCleanup(self.__vfs_server.tearDown)
1961
return self.__vfs_server
1963
def make_branch_and_tree(self, relpath, format=None):
1964
"""Create a branch on the transport and a tree locally.
1966
If the transport is not a LocalTransport, the Tree can't be created on
1967
the transport. In that case if the vfs_transport_factory is
1968
LocalURLServer the working tree is created in the local
1969
directory backing the transport, and the returned tree's branch and
1970
repository will also be accessed locally. Otherwise a lightweight
1971
checkout is created and returned.
1973
:param format: The BzrDirFormat.
1974
:returns: the WorkingTree.
1976
# TODO: always use the local disk path for the working tree,
1977
# this obviously requires a format that supports branch references
1978
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1980
b = self.make_branch(relpath, format=format)
1982
return b.bzrdir.create_workingtree()
1983
except errors.NotLocalUrl:
1984
# We can only make working trees locally at the moment. If the
1985
# transport can't support them, then we keep the non-disk-backed
1986
# branch and create a local checkout.
1987
if self.vfs_transport_factory is LocalURLServer:
1988
# the branch is colocated on disk, we cannot create a checkout.
1989
# hopefully callers will expect this.
1990
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
1991
return local_controldir.create_workingtree()
1993
return b.create_checkout(relpath, lightweight=True)
1995
def assertIsDirectory(self, relpath, transport):
1996
"""Assert that relpath within transport is a directory.
1998
This may not be possible on all transports; in that case it propagates
1999
a TransportNotPossible.
2002
mode = transport.stat(relpath).st_mode
2003
except errors.NoSuchFile:
2004
self.fail("path %s is not a directory; no such file"
2006
if not stat.S_ISDIR(mode):
2007
self.fail("path %s is not a directory; has mode %#o"
2010
def assertTreesEqual(self, left, right):
2011
"""Check that left and right have the same content and properties."""
2012
# we use a tree delta to check for equality of the content, and we
2013
# manually check for equality of other things such as the parents list.
2014
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2015
differences = left.changes_from(right)
2016
self.assertFalse(differences.has_changed(),
2017
"Trees %r and %r are different: %r" % (left, right, differences))
2020
super(TestCaseWithTransport, self).setUp()
2021
self.__vfs_server = None
2024
class ChrootedTestCase(TestCaseWithTransport):
2025
"""A support class that provides readonly urls outside the local namespace.
2027
This is done by checking if self.transport_server is a MemoryServer. if it
2028
is then we are chrooted already, if it is not then an HttpServer is used
2031
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2032
be used without needed to redo it when a different
2033
subclass is in use ?
2037
super(ChrootedTestCase, self).setUp()
2038
if not self.vfs_transport_factory == MemoryServer:
2039
self.transport_readonly_server = HttpServer
2042
def filter_suite_by_re(suite, pattern):
2043
result = TestUtil.TestSuite()
2044
filter_re = re.compile(pattern)
2045
for test in iter_suite_tests(suite):
2046
if filter_re.search(test.id()):
2047
result.addTest(test)
2051
def sort_suite_by_re(suite, pattern):
2054
filter_re = re.compile(pattern)
2055
for test in iter_suite_tests(suite):
2056
if filter_re.search(test.id()):
2060
return TestUtil.TestSuite(first + second)
2063
def run_suite(suite, name='test', verbose=False, pattern=".*",
2064
stop_on_failure=False, keep_output=False,
2065
transport=None, lsprof_timed=None, bench_history=None,
2066
matching_tests_first=None,
2067
numbered_dirs=None):
2068
global NUMBERED_DIRS
2069
if numbered_dirs is not None:
2070
NUMBERED_DIRS = bool(numbered_dirs)
2072
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2077
runner = TextTestRunner(stream=sys.stdout,
2079
verbosity=verbosity,
2080
keep_output=keep_output,
2081
bench_history=bench_history)
2082
runner.stop_on_failure=stop_on_failure
2084
if matching_tests_first:
2085
suite = sort_suite_by_re(suite, pattern)
2087
suite = filter_suite_by_re(suite, pattern)
2088
result = runner.run(suite)
2089
return result.wasSuccessful()
2092
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2095
test_suite_factory=None,
2098
matching_tests_first=None,
2099
numbered_dirs=None):
2100
"""Run the whole test suite under the enhanced runner"""
2101
# XXX: Very ugly way to do this...
2102
# Disable warning about old formats because we don't want it to disturb
2103
# any blackbox tests.
2104
from bzrlib import repository
2105
repository._deprecation_warning_done = True
2107
global default_transport
2108
if transport is None:
2109
transport = default_transport
2110
old_transport = default_transport
2111
default_transport = transport
2113
if test_suite_factory is None:
2114
suite = test_suite()
2116
suite = test_suite_factory()
2117
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2118
stop_on_failure=stop_on_failure, keep_output=keep_output,
2119
transport=transport,
2120
lsprof_timed=lsprof_timed,
2121
bench_history=bench_history,
2122
matching_tests_first=matching_tests_first,
2123
numbered_dirs=numbered_dirs)
2125
default_transport = old_transport
2129
"""Build and return TestSuite for the whole of bzrlib.
2131
This function can be replaced if you need to change the default test
2132
suite on a global basis, but it is not encouraged.
2135
'bzrlib.tests.test_ancestry',
2136
'bzrlib.tests.test_annotate',
2137
'bzrlib.tests.test_api',
2138
'bzrlib.tests.test_atomicfile',
2139
'bzrlib.tests.test_bad_files',
2140
'bzrlib.tests.test_branch',
2141
'bzrlib.tests.test_bundle',
2142
'bzrlib.tests.test_bzrdir',
2143
'bzrlib.tests.test_cache_utf8',
2144
'bzrlib.tests.test_commands',
2145
'bzrlib.tests.test_commit',
2146
'bzrlib.tests.test_commit_merge',
2147
'bzrlib.tests.test_config',
2148
'bzrlib.tests.test_conflicts',
2149
'bzrlib.tests.test_decorators',
2150
'bzrlib.tests.test_delta',
2151
'bzrlib.tests.test_diff',
2152
'bzrlib.tests.test_dirstate',
2153
'bzrlib.tests.test_doc_generate',
2154
'bzrlib.tests.test_errors',
2155
'bzrlib.tests.test_escaped_store',
2156
'bzrlib.tests.test_extract',
2157
'bzrlib.tests.test_fetch',
2158
'bzrlib.tests.test_ftp_transport',
2159
'bzrlib.tests.test_generate_docs',
2160
'bzrlib.tests.test_generate_ids',
2161
'bzrlib.tests.test_globbing',
2162
'bzrlib.tests.test_gpg',
2163
'bzrlib.tests.test_graph',
2164
'bzrlib.tests.test_hashcache',
2165
'bzrlib.tests.test_http',
2166
'bzrlib.tests.test_http_response',
2167
'bzrlib.tests.test_https_ca_bundle',
2168
'bzrlib.tests.test_identitymap',
2169
'bzrlib.tests.test_ignores',
2170
'bzrlib.tests.test_inv',
2171
'bzrlib.tests.test_knit',
2172
'bzrlib.tests.test_lazy_import',
2173
'bzrlib.tests.test_lazy_regex',
2174
'bzrlib.tests.test_lockdir',
2175
'bzrlib.tests.test_lockable_files',
2176
'bzrlib.tests.test_log',
2177
'bzrlib.tests.test_memorytree',
2178
'bzrlib.tests.test_merge',
2179
'bzrlib.tests.test_merge3',
2180
'bzrlib.tests.test_merge_core',
2181
'bzrlib.tests.test_merge_directive',
2182
'bzrlib.tests.test_missing',
2183
'bzrlib.tests.test_msgeditor',
2184
'bzrlib.tests.test_nonascii',
2185
'bzrlib.tests.test_options',
2186
'bzrlib.tests.test_osutils',
2187
'bzrlib.tests.test_osutils_encodings',
2188
'bzrlib.tests.test_patch',
2189
'bzrlib.tests.test_patches',
2190
'bzrlib.tests.test_permissions',
2191
'bzrlib.tests.test_plugins',
2192
'bzrlib.tests.test_progress',
2193
'bzrlib.tests.test_reconcile',
2194
'bzrlib.tests.test_registry',
2195
'bzrlib.tests.test_remote',
2196
'bzrlib.tests.test_repository',
2197
'bzrlib.tests.test_revert',
2198
'bzrlib.tests.test_revision',
2199
'bzrlib.tests.test_revisionnamespaces',
2200
'bzrlib.tests.test_revisiontree',
2201
'bzrlib.tests.test_rio',
2202
'bzrlib.tests.test_sampler',
2203
'bzrlib.tests.test_selftest',
2204
'bzrlib.tests.test_setup',
2205
'bzrlib.tests.test_sftp_transport',
2206
'bzrlib.tests.test_smart',
2207
'bzrlib.tests.test_smart_add',
2208
'bzrlib.tests.test_smart_transport',
2209
'bzrlib.tests.test_source',
2210
'bzrlib.tests.test_ssh_transport',
2211
'bzrlib.tests.test_status',
2212
'bzrlib.tests.test_store',
2213
'bzrlib.tests.test_subsume',
2214
'bzrlib.tests.test_symbol_versioning',
2215
'bzrlib.tests.test_tag',
2216
'bzrlib.tests.test_testament',
2217
'bzrlib.tests.test_textfile',
2218
'bzrlib.tests.test_textmerge',
2219
'bzrlib.tests.test_timestamp',
2220
'bzrlib.tests.test_trace',
2221
'bzrlib.tests.test_transactions',
2222
'bzrlib.tests.test_transform',
2223
'bzrlib.tests.test_transport',
2224
'bzrlib.tests.test_tree',
2225
'bzrlib.tests.test_treebuilder',
2226
'bzrlib.tests.test_tsort',
2227
'bzrlib.tests.test_tuned_gzip',
2228
'bzrlib.tests.test_ui',
2229
'bzrlib.tests.test_upgrade',
2230
'bzrlib.tests.test_urlutils',
2231
'bzrlib.tests.test_versionedfile',
2232
'bzrlib.tests.test_version',
2233
'bzrlib.tests.test_version_info',
2234
'bzrlib.tests.test_weave',
2235
'bzrlib.tests.test_whitebox',
2236
'bzrlib.tests.test_workingtree',
2237
'bzrlib.tests.test_workingtree_4',
2238
'bzrlib.tests.test_wsgi',
2239
'bzrlib.tests.test_xml',
2241
test_transport_implementations = [
2242
'bzrlib.tests.test_transport_implementations',
2243
'bzrlib.tests.test_read_bundle',
2245
suite = TestUtil.TestSuite()
2246
loader = TestUtil.TestLoader()
2247
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2248
from bzrlib.transport import TransportTestProviderAdapter
2249
adapter = TransportTestProviderAdapter()
2250
adapt_modules(test_transport_implementations, adapter, loader, suite)
2251
for package in packages_to_test():
2252
suite.addTest(package.test_suite())
2253
for m in MODULES_TO_TEST:
2254
suite.addTest(loader.loadTestsFromModule(m))
2255
for m in MODULES_TO_DOCTEST:
2257
suite.addTest(doctest.DocTestSuite(m))
2258
except ValueError, e:
2259
print '**failed to get doctest for: %s\n%s' %(m,e)
2261
for name, plugin in bzrlib.plugin.all_plugins().items():
2262
if getattr(plugin, 'test_suite', None) is not None:
2263
default_encoding = sys.getdefaultencoding()
2265
plugin_suite = plugin.test_suite()
2266
except ImportError, e:
2267
bzrlib.trace.warning(
2268
'Unable to test plugin "%s": %s', name, e)
2270
suite.addTest(plugin_suite)
2271
if default_encoding != sys.getdefaultencoding():
2272
bzrlib.trace.warning(
2273
'Plugin "%s" tried to reset default encoding to: %s', name,
2274
sys.getdefaultencoding())
2276
sys.setdefaultencoding(default_encoding)
2280
def adapt_modules(mods_list, adapter, loader, suite):
2281
"""Adapt the modules in mods_list using adapter and add to suite."""
2282
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2283
suite.addTests(adapter.adapt(test))
2286
def clean_selftest_output(root=None, quiet=False):
2287
"""Remove all selftest output directories from root directory.
2289
:param root: root directory for clean
2290
(if ommitted or None then clean current directory).
2291
:param quiet: suppress report about deleting directories
2296
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2299
for i in os.listdir(root):
2300
if os.path.isdir(i) and re_dir.match(i):
2302
print 'delete directory:', i
2306
class Feature(object):
2307
"""An operating system Feature."""
2310
self._available = None
2312
def available(self):
2313
"""Is the feature available?
2315
:return: True if the feature is available.
2317
if self._available is None:
2318
self._available = self._probe()
2319
return self._available
2322
"""Implement this method in concrete features.
2324
:return: True if the feature is available.
2326
raise NotImplementedError
2329
if getattr(self, 'feature_name', None):
2330
return self.feature_name()
2331
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
