1
# Copyright (C) 2005, 2006, 2007 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.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
18
from unittest import TestResult, TestCase
71
# lsprof not available
22
from subprocess import call, Popen, PIPE
23
except ImportError, e:
24
sys.stderr.write("testbzr: sorry, this test suite requires the subprocess module\n"
25
"this is shipped with python2.4 and available separately for 2.3\n")
29
class CommandFailed(Exception):
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.interrepository_implementations
132
import bzrlib.tests.interversionedfile_implementations
133
import bzrlib.tests.intertree_implementations
134
import bzrlib.tests.per_lock
135
import bzrlib.tests.repository_implementations
136
import bzrlib.tests.revisionstore_implementations
137
import bzrlib.tests.tree_implementations
138
import bzrlib.tests.workingtree_implementations
141
bzrlib.tests.blackbox,
142
bzrlib.tests.branch_implementations,
143
bzrlib.tests.bzrdir_implementations,
144
bzrlib.tests.interrepository_implementations,
145
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
bzrlib.tests.repository_implementations,
149
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
156
"""Accepts, reports and accumulates the results of running tests.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
165
def __init__(self, stream, descriptions, verbosity,
168
use_numbered_dirs=False,
170
"""Construct new TestResult.
172
:param bench_history: Optionally, a writable file object to accumulate
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
176
if bench_history is not None:
177
from bzrlib.version import _get_bzr_source_tree
178
src_tree = _get_bzr_source_tree()
181
revision_id = src_tree.get_parent_ids()[0]
183
# XXX: if this is a brand new tree, do the same as if there
187
# XXX: If there's no branch, what should we do?
189
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
190
self._bench_history = bench_history
191
self.ui = ui.ui_factory
192
self.num_tests = num_tests
194
self.failure_count = 0
195
self.known_failure_count = 0
197
self.unsupported = {}
199
self.use_numbered_dirs = use_numbered_dirs
200
self._overall_start_time = time.time()
202
def extractBenchmarkTime(self, testCase):
203
"""Add a benchmark time for the current test case."""
204
self._benchmarkTime = getattr(testCase, "_benchtime", None)
206
def _elapsedTestTimeString(self):
207
"""Return a time string for the overall time the current test has taken."""
208
return self._formatTime(time.time() - self._start_time)
210
def _testTimeString(self):
211
if self._benchmarkTime is not None:
213
self._formatTime(self._benchmarkTime),
214
self._elapsedTestTimeString())
216
return " %s" % self._elapsedTestTimeString()
218
def _formatTime(self, seconds):
219
"""Format seconds as milliseconds with leading spaces."""
220
# some benchmarks can take thousands of seconds to run, so we need 8
222
return "%8dms" % (1000 * seconds)
224
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
33
class TestBase(TestCase):
34
"""Base class for bzr test cases.
36
Just defines some useful helper functions; doesn't actually test
40
# TODO: Special methods to invoke bzr, so that we can run it
41
# through a specified Python intepreter
43
OVERRIDE_PYTHON = None # to run with alternative python 'python'
47
def formcmd(self, cmd):
48
if isinstance(cmd, basestring):
53
if self.OVERRIDE_PYTHON:
54
cmd.insert(0, self.OVERRIDE_PYTHON)
56
self.log('$ %r' % cmd)
61
def runcmd(self, cmd, retcode=0):
62
"""Run one command and check the return code.
64
Returns a tuple of (stdout,stderr) strings.
66
If a single string is based, it is split into words.
67
For commands that are not simple space-separated words, please
68
pass a list instead."""
69
cmd = self.formcmd(cmd)
71
self.log('$ ' + ' '.join(cmd))
72
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
74
if retcode != actual_retcode:
75
raise CommandFailed("test failed: %r returned %d, expected %d"
76
% (cmd, actual_retcode, retcode))
79
def backtick(self, cmd, retcode=0):
80
cmd = self.formcmd(cmd)
81
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
82
outd, errd = child.communicate()
84
actual_retcode = child.wait()
86
outd = outd.replace('\r', '')
88
if retcode != actual_retcode:
89
raise CommandFailed("test failed: %r returned %d, expected %d"
90
% (cmd, actual_retcode, retcode))
98
"""Log a message to a progress file"""
99
print >>self.TEST_LOG, msg
102
class InTempDir(TestBase):
103
"""Base class for tests run in a temporary branch."""
106
self.test_dir = os.path.join(self.TEST_ROOT, self.__class__.__name__)
107
os.mkdir(self.test_dir)
108
os.chdir(self.test_dir)
112
os.chdir(self.TEST_ROOT)
118
class _MyResult(TestResult):
122
No special behaviour for now.
229
124
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
231
self.report_test_start(test)
232
test.number = self.count
233
self._recordTestStartTime()
235
def _recordTestStartTime(self):
236
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
125
print str(test).ljust(60),
126
TestResult.startTest(self, test)
128
def stopTest(self, test):
130
TestResult.stopTest(self, test)
246
133
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
254
self.error_count += 1
255
self.report_error(test, err)
135
TestResult.addError(self, test, err)
259
137
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
265
self.failure_count += 1
266
self.report_failure(test, err)
270
def addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
self.unsupported.setdefault(str(feature), 0)
276
self.unsupported[str(feature)] += 1
277
self.report_unsupported(test, feature)
139
TestResult.addFailure(self, test, err)
279
141
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
309
if getattr(test, '_get_log', None) is not None:
311
print >>self.stream, \
312
('vvvv[log from %s]' % test.id()).ljust(78,'-')
313
print >>self.stream, test._get_log()
314
print >>self.stream, \
315
('^^^^[log from %s]' % test.id()).ljust(78,'-')
316
self.stream.writeln(self.separator2)
317
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
325
def report_success(self, test):
329
class TextTestResult(ExtendedTestResult):
330
"""Displays progress and results of tests in text form"""
332
def __init__(self, stream, descriptions, verbosity,
336
use_numbered_dirs=False,
338
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
346
self.pb.show_pct = False
347
self.pb.show_spinner = False
348
self.pb.show_eta = False,
349
self.pb.show_count = False
350
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
355
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
358
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
373
def report_test_start(self, test):
376
self._progress_prefix_text()
378
+ self._shortened_test_description(test))
380
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
387
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
389
self._test_description(test),
393
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
395
self._test_description(test),
399
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
419
def report_unsupported(self, test, feature):
420
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
class VerboseTestResult(ExtendedTestResult):
431
"""Produce long output, with one line per test run plus times"""
433
def _ellipsize_to_right(self, a_string, final_width):
434
"""Truncate and pad a string, keeping the right hand side"""
435
if len(a_string) > final_width:
436
result = '...' + a_string[3-final_width:]
439
return result.ljust(final_width)
441
def report_starting(self):
442
self.stream.write('running %d tests...\n' % self.num_tests)
444
def report_test_start(self, test):
446
name = self._shortened_test_description(test)
447
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
448
# numbers, plus a trailing blank
449
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
450
if self.use_numbered_dirs:
451
self.stream.write('%5d ' % self.count)
452
self.stream.write(self._ellipsize_to_right(name,
453
osutils.terminal_width()-36))
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
if self.use_numbered_dirs:
463
return '%s%s' % (indent, err[1])
465
def report_error(self, test, err):
466
self.stream.writeln('ERROR %s\n%s'
467
% (self._testTimeString(),
468
self._error_summary(err)))
470
def report_failure(self, test, err):
471
self.stream.writeln(' FAIL %s\n%s'
472
% (self._testTimeString(),
473
self._error_summary(err)))
475
def report_known_failure(self, test, err):
476
self.stream.writeln('XFAIL %s\n%s'
477
% (self._testTimeString(),
478
self._error_summary(err)))
480
def report_success(self, test):
481
self.stream.writeln(' OK %s' % self._testTimeString())
482
for bench_called, stats in getattr(test, '_benchcalls', []):
483
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
484
stats.pprint(file=self.stream)
485
# flush the stream so that we get smooth output. This verbose mode is
486
# used to show the output in PQM.
489
def report_skip(self, test, skip_excinfo):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(),
493
self._error_summary(skip_excinfo)))
495
def report_unsupported(self, test, feature):
496
"""test cannot be run because feature is missing."""
497
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
498
%(self._testTimeString(), feature))
502
class TextTestRunner(object):
503
stop_on_failure = False
510
use_numbered_dirs=False,
513
self.stream = unittest._WritelnDecorator(stream)
514
self.descriptions = descriptions
515
self.verbosity = verbosity
516
self._bench_history = bench_history
517
self.use_numbered_dirs = use_numbered_dirs
518
self.list_only = list_only
521
"Run the given test case or test suite."
522
startTime = time.time()
523
if self.verbosity == 1:
524
result_class = TextTestResult
525
elif self.verbosity >= 2:
526
result_class = VerboseTestResult
527
result = result_class(self.stream,
530
bench_history=self._bench_history,
531
num_tests=test.countTestCases(),
532
use_numbered_dirs=self.use_numbered_dirs,
534
result.stop_early = self.stop_on_failure
535
result.report_starting()
537
if self.verbosity >= 2:
538
self.stream.writeln("Listing tests only ...\n")
540
for t in iter_suite_tests(test):
541
self.stream.writeln("%s" % (t.id()))
543
actionTaken = "Listed"
546
run = result.testsRun
548
stopTime = time.time()
549
timeTaken = stopTime - startTime
551
self.stream.writeln(result.separator2)
552
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
553
run, run != 1 and "s" or "", timeTaken))
554
self.stream.writeln()
555
if not result.wasSuccessful():
556
self.stream.write("FAILED (")
557
failed, errored = map(len, (result.failures, result.errors))
559
self.stream.write("failures=%d" % failed)
561
if failed: self.stream.write(", ")
562
self.stream.write("errors=%d" % errored)
563
if result.known_failure_count:
564
if failed or errored: self.stream.write(", ")
565
self.stream.write("known_failure_count=%d" %
566
result.known_failure_count)
567
self.stream.writeln(")")
569
if result.known_failure_count:
570
self.stream.writeln("OK (known_failures=%d)" %
571
result.known_failure_count)
573
self.stream.writeln("OK")
574
if result.skip_count > 0:
575
skipped = result.skip_count
576
self.stream.writeln('%d test%s skipped' %
577
(skipped, skipped != 1 and "s" or ""))
578
if result.unsupported:
579
for feature, count in sorted(result.unsupported.items()):
580
self.stream.writeln("Missing feature '%s' skipped %d tests." %
586
def iter_suite_tests(suite):
587
"""Return all tests in a suite, recursing through nested suites"""
588
for item in suite._tests:
589
if isinstance(item, unittest.TestCase):
591
elif isinstance(item, unittest.TestSuite):
592
for r in iter_suite_tests(item):
595
raise Exception('unknown object %r inside test suite %r'
599
class TestSkipped(Exception):
600
"""Indicates that a test was intentionally skipped, rather than failing."""
603
class KnownFailure(AssertionError):
604
"""Indicates that a test failed in a precisely expected manner.
606
Such failures dont block the whole test suite from passing because they are
607
indicators of partially completed code or of future work. We have an
608
explicit error for them so that we can ensure that they are always visible:
609
KnownFailures are always shown in the output of bzr selftest.
613
class UnavailableFeature(Exception):
614
"""A feature required for this test was not available.
616
The feature should be used to construct the exception.
620
class CommandFailed(Exception):
624
class StringIOWrapper(object):
625
"""A wrapper around cStringIO which just adds an encoding attribute.
627
Internally we can check sys.stdout to see what the output encoding
628
should be. However, cStringIO has no encoding attribute that we can
629
set. So we wrap it instead.
634
def __init__(self, s=None):
636
self.__dict__['_cstring'] = StringIO(s)
638
self.__dict__['_cstring'] = StringIO()
640
def __getattr__(self, name, getattr=getattr):
641
return getattr(self.__dict__['_cstring'], name)
643
def __setattr__(self, name, val):
644
if name == 'encoding':
645
self.__dict__['encoding'] = val
647
return setattr(self._cstring, name, val)
650
class TestUIFactory(ui.CLIUIFactory):
651
"""A UI Factory for testing.
653
Hide the progress bar but emit note()s.
655
Allows get_password to be tested without real tty attached.
662
super(TestUIFactory, self).__init__()
663
if stdin is not None:
664
# We use a StringIOWrapper to be able to test various
665
# encodings, but the user is still responsible to
666
# encode the string and to set the encoding attribute
667
# of StringIOWrapper.
668
self.stdin = StringIOWrapper(stdin)
670
self.stdout = sys.stdout
674
self.stderr = sys.stderr
679
"""See progress.ProgressBar.clear()."""
681
def clear_term(self):
682
"""See progress.ProgressBar.clear_term()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
688
"""See progress.ProgressBar.finished()."""
690
def note(self, fmt_string, *args, **kwargs):
691
"""See progress.ProgressBar.note()."""
692
self.stdout.write((fmt_string + "\n") % args)
694
def progress_bar(self):
697
def nested_progress_bar(self):
700
def update(self, message, count=None, total=None):
701
"""See progress.ProgressBar.update()."""
703
def get_non_echoed_password(self, prompt):
704
"""Get password from stdin without trying to handle the echo mode"""
706
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
707
password = self.stdin.readline()
710
if password[-1] == '\n':
711
password = password[:-1]
715
class TestCase(unittest.TestCase):
716
"""Base class for bzr unit tests.
718
Tests that need access to disk resources should subclass
719
TestCaseInTempDir not TestCase.
721
Error and debug log messages are redirected from their usual
722
location into a temporary file, the contents of which can be
723
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
so that it can also capture file IO. When the test completes this file
725
is read into memory and removed from disk.
727
There are also convenience functions to invoke bzr's command-line
728
routine, and to build and check bzr trees.
730
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
732
run in order as the object is torn down. It's less likely this will be
733
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
# record lsprof data when performing benchmark calls.
740
_gather_lsprof_in_benchmarks = False
742
def __init__(self, methodName='testMethod'):
743
super(TestCase, self).__init__(methodName)
747
unittest.TestCase.setUp(self)
748
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
752
self._benchcalls = []
753
self._benchtime = None
755
self._clear_debug_flags()
757
def _clear_debug_flags(self):
758
"""Prevent externally set debug flags affecting tests.
760
Tests that want to use debug flags can just set them in the
761
debug_flags set during setup/teardown.
763
self._preserved_debug_flags = set(debug.debug_flags)
764
debug.debug_flags.clear()
765
self.addCleanup(self._restore_debug_flags)
767
def _clear_hooks(self):
768
# prevent hooks affecting tests
770
import bzrlib.smart.server
771
self._preserved_hooks = {
772
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
773
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
775
self.addCleanup(self._restoreHooks)
776
# reset all hooks to an empty instance of the appropriate type
777
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
778
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
780
def _silenceUI(self):
781
"""Turn off UI for duration of test"""
782
# by default the UI is off; tests can turn it on if they want it.
783
saved = ui.ui_factory
785
ui.ui_factory = saved
786
ui.ui_factory = ui.SilentUIFactory()
787
self.addCleanup(_restore)
789
def _ndiff_strings(self, a, b):
790
"""Return ndiff between two strings containing lines.
792
A trailing newline is added if missing to make the strings
794
if b and b[-1] != '\n':
796
if a and a[-1] != '\n':
798
difflines = difflib.ndiff(a.splitlines(True),
800
linejunk=lambda x: False,
801
charjunk=lambda x: False)
802
return ''.join(difflines)
804
def assertEqual(self, a, b, message=''):
808
except UnicodeError, e:
809
# If we can't compare without getting a UnicodeError, then
810
# obviously they are different
811
mutter('UnicodeError: %s', e)
814
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
816
pformat(a), pformat(b)))
818
assertEquals = assertEqual
820
def assertEqualDiff(self, a, b, message=None):
821
"""Assert two texts are equal, if not raise an exception.
823
This is intended for use with multi-line strings where it can
824
be hard to find the differences by eye.
826
# TODO: perhaps override assertEquals to call this for strings?
830
message = "texts not equal:\n"
831
raise AssertionError(message +
832
self._ndiff_strings(a, b))
834
def assertEqualMode(self, mode, mode_test):
835
self.assertEqual(mode, mode_test,
836
'mode mismatch %o != %o' % (mode, mode_test))
838
def assertStartsWith(self, s, prefix):
839
if not s.startswith(prefix):
840
raise AssertionError('string %r does not start with %r' % (s, prefix))
842
def assertEndsWith(self, s, suffix):
843
"""Asserts that s ends with suffix."""
844
if not s.endswith(suffix):
845
raise AssertionError('string %r does not end with %r' % (s, suffix))
847
def assertContainsRe(self, haystack, needle_re):
848
"""Assert that a contains something matching a regular expression."""
849
if not re.search(needle_re, haystack):
850
if '\n' in haystack or len(haystack) > 60:
851
# a long string, format it in a more readable way
852
raise AssertionError(
853
'pattern "%s" not found in\n"""\\\n%s"""\n'
854
% (needle_re, haystack))
856
raise AssertionError('pattern "%s" not found in "%s"'
857
% (needle_re, haystack))
859
def assertNotContainsRe(self, haystack, needle_re):
860
"""Assert that a does not match a regular expression"""
861
if re.search(needle_re, haystack):
862
raise AssertionError('pattern "%s" found in "%s"'
863
% (needle_re, haystack))
865
def assertSubset(self, sublist, superlist):
866
"""Assert that every entry in sublist is present in superlist."""
868
for entry in sublist:
869
if entry not in superlist:
870
missing.append(entry)
872
raise AssertionError("value(s) %r not present in container %r" %
873
(missing, superlist))
875
def assertListRaises(self, excClass, func, *args, **kwargs):
876
"""Fail unless excClass is raised when the iterator from func is used.
878
Many functions can return generators this makes sure
879
to wrap them in a list() call to make sure the whole generator
880
is run, and that the proper exception is raised.
883
list(func(*args, **kwargs))
887
if getattr(excClass,'__name__', None) is not None:
888
excName = excClass.__name__
890
excName = str(excClass)
891
raise self.failureException, "%s not raised" % excName
893
def assertRaises(self, excClass, callableObj, *args, **kwargs):
894
"""Assert that a callable raises a particular exception.
896
:param excClass: As for the except statement, this may be either an
897
exception class, or a tuple of classes.
898
:param callableObj: A callable, will be passed ``*args`` and
901
Returns the exception so that you can examine it.
904
callableObj(*args, **kwargs)
908
if getattr(excClass,'__name__', None) is not None:
909
excName = excClass.__name__
912
excName = str(excClass)
913
raise self.failureException, "%s not raised" % excName
915
def assertIs(self, left, right, message=None):
916
if not (left is right):
917
if message is not None:
918
raise AssertionError(message)
920
raise AssertionError("%r is not %r." % (left, right))
922
def assertIsNot(self, left, right, message=None):
924
if message is not None:
925
raise AssertionError(message)
927
raise AssertionError("%r is %r." % (left, right))
929
def assertTransportMode(self, transport, path, mode):
930
"""Fail if a path does not have mode mode.
932
If modes are not supported on this transport, the assertion is ignored.
934
if not transport._can_roundtrip_unix_modebits():
936
path_stat = transport.stat(path)
937
actual_mode = stat.S_IMODE(path_stat.st_mode)
938
self.assertEqual(mode, actual_mode,
939
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
941
def assertIsInstance(self, obj, kls):
942
"""Fail if obj is not an instance of kls"""
943
if not isinstance(obj, kls):
944
self.fail("%r is an instance of %s rather than %s" % (
945
obj, obj.__class__, kls))
947
def expectFailure(self, reason, assertion, *args, **kwargs):
948
"""Invoke a test, expecting it to fail for the given reason.
950
This is for assertions that ought to succeed, but currently fail.
951
(The failure is *expected* but not *wanted*.) Please be very precise
952
about the failure you're expecting. If a new bug is introduced,
953
AssertionError should be raised, not KnownFailure.
955
Frequently, expectFailure should be followed by an opposite assertion.
958
Intended to be used with a callable that raises AssertionError as the
959
'assertion' parameter. args and kwargs are passed to the 'assertion'.
961
Raises KnownFailure if the test fails. Raises AssertionError if the
966
self.expectFailure('Math is broken', self.assertNotEqual, 54,
968
self.assertEqual(42, dynamic_val)
970
This means that a dynamic_val of 54 will cause the test to raise
971
a KnownFailure. Once math is fixed and the expectFailure is removed,
972
only a dynamic_val of 42 will allow the test to pass. Anything other
973
than 54 or 42 will cause an AssertionError.
976
assertion(*args, **kwargs)
977
except AssertionError:
978
raise KnownFailure(reason)
980
self.fail('Unexpected success. Should have failed: %s' % reason)
982
def _capture_warnings(self, a_callable, *args, **kwargs):
983
"""A helper for callDeprecated and applyDeprecated.
985
:param a_callable: A callable to call.
986
:param args: The positional arguments for the callable
987
:param kwargs: The keyword arguments for the callable
988
:return: A tuple (warnings, result). result is the result of calling
989
a_callable(``*args``, ``**kwargs``).
992
def capture_warnings(msg, cls=None, stacklevel=None):
993
# we've hooked into a deprecation specific callpath,
994
# only deprecations should getting sent via it.
995
self.assertEqual(cls, DeprecationWarning)
996
local_warnings.append(msg)
997
original_warning_method = symbol_versioning.warn
998
symbol_versioning.set_warning_method(capture_warnings)
1000
result = a_callable(*args, **kwargs)
1002
symbol_versioning.set_warning_method(original_warning_method)
1003
return (local_warnings, result)
1005
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1006
"""Call a deprecated callable without warning the user.
1008
Note that this only captures warnings raised by symbol_versioning.warn,
1009
not other callers that go direct to the warning module.
1011
:param deprecation_format: The deprecation format that the callable
1012
should have been deprecated with. This is the same type as the
1013
parameter to deprecated_method/deprecated_function. If the
1014
callable is not deprecated with this format, an assertion error
1016
:param a_callable: A callable to call. This may be a bound method or
1017
a regular function. It will be called with ``*args`` and
1019
:param args: The positional arguments for the callable
1020
:param kwargs: The keyword arguments for the callable
1021
:return: The result of a_callable(``*args``, ``**kwargs``)
1023
call_warnings, result = self._capture_warnings(a_callable,
1025
expected_first_warning = symbol_versioning.deprecation_string(
1026
a_callable, deprecation_format)
1027
if len(call_warnings) == 0:
1028
self.fail("No deprecation warning generated by call to %s" %
1030
self.assertEqual(expected_first_warning, call_warnings[0])
1033
def callDeprecated(self, expected, callable, *args, **kwargs):
1034
"""Assert that a callable is deprecated in a particular way.
1036
This is a very precise test for unusual requirements. The
1037
applyDeprecated helper function is probably more suited for most tests
1038
as it allows you to simply specify the deprecation format being used
1039
and will ensure that that is issued for the function being called.
1041
Note that this only captures warnings raised by symbol_versioning.warn,
1042
not other callers that go direct to the warning module.
1044
:param expected: a list of the deprecation warnings expected, in order
1045
:param callable: The callable to call
1046
:param args: The positional arguments for the callable
1047
:param kwargs: The keyword arguments for the callable
1049
call_warnings, result = self._capture_warnings(callable,
1051
self.assertEqual(expected, call_warnings)
1054
def _startLogFile(self):
1055
"""Send bzr and test log messages to a temporary file.
1057
The file is removed as the test is torn down.
1059
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1060
self._log_file = os.fdopen(fileno, 'w+')
1061
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1062
self._log_file_name = name
1063
self.addCleanup(self._finishLogFile)
1065
def _finishLogFile(self):
1066
"""Finished with the log file.
1068
Close the file and delete it, unless setKeepLogfile was called.
1070
if self._log_file is None:
1072
bzrlib.trace.disable_test_log(self._log_nonce)
1073
self._log_file.close()
1074
self._log_file = None
1075
if not self._keep_log_file:
1076
os.remove(self._log_file_name)
1077
self._log_file_name = None
1079
def setKeepLogfile(self):
1080
"""Make the logfile not be deleted when _finishLogFile is called."""
1081
self._keep_log_file = True
1083
def addCleanup(self, callable):
1084
"""Arrange to run a callable when this case is torn down.
1086
Callables are run in the reverse of the order they are registered,
1087
ie last-in first-out.
1089
if callable in self._cleanups:
1090
raise ValueError("cleanup function %r already registered on %s"
1092
self._cleanups.append(callable)
1094
def _cleanEnvironment(self):
1096
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1097
'HOME': os.getcwd(),
1098
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1100
'BZREMAIL': None, # may still be present in the environment
1102
'BZR_PROGRESS_BAR': None,
1106
'https_proxy': None,
1107
'HTTPS_PROXY': None,
1112
# Nobody cares about these ones AFAIK. So far at
1113
# least. If you do (care), please update this comment
1117
'BZR_REMOTE_PATH': None,
1120
self.addCleanup(self._restoreEnvironment)
1121
for name, value in new_env.iteritems():
1122
self._captureVar(name, value)
1124
def _captureVar(self, name, newvalue):
1125
"""Set an environment variable, and reset it when finished."""
1126
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1128
def _restore_debug_flags(self):
1129
debug.debug_flags.clear()
1130
debug.debug_flags.update(self._preserved_debug_flags)
1132
def _restoreEnvironment(self):
1133
for name, value in self.__old_env.iteritems():
1134
osutils.set_or_unset_env(name, value)
1136
def _restoreHooks(self):
1137
for klass, hooks in self._preserved_hooks.items():
1138
setattr(klass, 'hooks', hooks)
1140
def knownFailure(self, reason):
1141
"""This test has failed for some known reason."""
1142
raise KnownFailure(reason)
1144
def run(self, result=None):
1145
if result is None: result = self.defaultTestResult()
1146
for feature in getattr(self, '_test_needs_features', []):
1147
if not feature.available():
1148
result.startTest(self)
1149
if getattr(result, 'addNotSupported', None):
1150
result.addNotSupported(self, feature)
1152
result.addSuccess(self)
1153
result.stopTest(self)
1155
return unittest.TestCase.run(self, result)
1159
unittest.TestCase.tearDown(self)
1161
def time(self, callable, *args, **kwargs):
1162
"""Run callable and accrue the time it takes to the benchmark time.
1164
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1165
this will cause lsprofile statistics to be gathered and stored in
1168
if self._benchtime is None:
1172
if not self._gather_lsprof_in_benchmarks:
1173
return callable(*args, **kwargs)
1175
# record this benchmark
1176
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1178
self._benchcalls.append(((callable, args, kwargs), stats))
1181
self._benchtime += time.time() - start
1183
def _runCleanups(self):
1184
"""Run registered cleanup functions.
1186
This should only be called from TestCase.tearDown.
1188
# TODO: Perhaps this should keep running cleanups even if
1189
# one of them fails?
1191
# Actually pop the cleanups from the list so tearDown running
1192
# twice is safe (this happens for skipped tests).
1193
while self._cleanups:
1194
self._cleanups.pop()()
1196
def log(self, *args):
1199
def _get_log(self, keep_log_file=False):
1200
"""Return as a string the log for this test. If the file is still
1201
on disk and keep_log_file=False, delete the log file and store the
1202
content in self._log_contents."""
1203
# flush the log file, to get all content
1205
bzrlib.trace._trace_file.flush()
1206
if self._log_contents:
1207
return self._log_contents
1208
if self._log_file_name is not None:
1209
logfile = open(self._log_file_name)
1211
log_contents = logfile.read()
1214
if not keep_log_file:
1215
self._log_contents = log_contents
1217
os.remove(self._log_file_name)
1219
if sys.platform == 'win32' and e.errno == errno.EACCES:
1220
print >>sys.stderr, ('Unable to delete log file '
1221
' %r' % self._log_file_name)
1226
return "DELETED log file to reduce memory footprint"
1228
@deprecated_method(zero_eighteen)
1229
def capture(self, cmd, retcode=0):
1230
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1231
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1233
def requireFeature(self, feature):
1234
"""This test requires a specific feature is available.
1236
:raises UnavailableFeature: When feature is not available.
1238
if not feature.available():
1239
raise UnavailableFeature(feature)
1241
@deprecated_method(zero_eighteen)
1242
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1244
"""Invoke bzr and return (stdout, stderr).
1246
Don't call this method, just use run_bzr() which is equivalent.
1248
:param argv: Arguments to invoke bzr. This may be either a
1249
single string, in which case it is split by shlex into words,
1250
or a list of arguments.
1251
:param retcode: Expected return code, or None for don't-care.
1252
:param encoding: Encoding for sys.stdout and sys.stderr
1253
:param stdin: A string to be used as stdin for the command.
1254
:param working_dir: Change to this directory before running
1256
return self._run_bzr_autosplit(argv, retcode=retcode,
1257
encoding=encoding, stdin=stdin, working_dir=working_dir,
1260
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1262
"""Run bazaar command line, splitting up a string command line."""
1263
if isinstance(args, basestring):
1264
args = list(shlex.split(args))
1265
return self._run_bzr_core(args, retcode=retcode,
1266
encoding=encoding, stdin=stdin, working_dir=working_dir,
1269
def _run_bzr_core(self, args, retcode, encoding, stdin,
1271
if encoding is None:
1272
encoding = bzrlib.user_encoding
1273
stdout = StringIOWrapper()
1274
stderr = StringIOWrapper()
1275
stdout.encoding = encoding
1276
stderr.encoding = encoding
1278
self.log('run bzr: %r', args)
1279
# FIXME: don't call into logging here
1280
handler = logging.StreamHandler(stderr)
1281
handler.setLevel(logging.INFO)
1282
logger = logging.getLogger('')
1283
logger.addHandler(handler)
1284
old_ui_factory = ui.ui_factory
1285
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1288
if working_dir is not None:
1289
cwd = osutils.getcwd()
1290
os.chdir(working_dir)
1293
result = self.apply_redirected(ui.ui_factory.stdin,
1295
bzrlib.commands.run_bzr_catch_errors,
1298
logger.removeHandler(handler)
1299
ui.ui_factory = old_ui_factory
1303
out = stdout.getvalue()
1304
err = stderr.getvalue()
1306
self.log('output:\n%r', out)
1308
self.log('errors:\n%r', err)
1309
if retcode is not None:
1310
self.assertEquals(retcode, result,
1311
message='Unexpected return code')
1314
def run_bzr(self, *args, **kwargs):
1315
"""Invoke bzr, as if it were run from the command line.
1317
The argument list should not include the bzr program name - the
1318
first argument is normally the bzr command. Arguments may be
1319
passed in three ways:
1321
1- A list of strings, eg ["commit", "a"]. This is recommended
1322
when the command contains whitespace or metacharacters, or
1323
is built up at run time.
1325
2- A single string, eg "add a". This is the most convenient
1326
for hardcoded commands.
1328
3- Several varargs parameters, eg run_bzr("add", "a").
1329
This is not recommended for new code.
1331
This runs bzr through the interface that catches and reports
1332
errors, and with logging set to something approximating the
1333
default, so that error reporting can be checked.
1335
This should be the main method for tests that want to exercise the
1336
overall behavior of the bzr application (rather than a unit test
1337
or a functional test of the library.)
1339
This sends the stdout/stderr results into the test's log,
1340
where it may be useful for debugging. See also run_captured.
1342
:keyword stdin: A string to be used as stdin for the command.
1343
:keyword retcode: The status code the command should return;
1345
:keyword working_dir: The directory to run the command in
1346
:keyword error_regexes: A list of expected error messages. If
1347
specified they must be seen in the error output of the command.
1349
retcode = kwargs.pop('retcode', 0)
1350
encoding = kwargs.pop('encoding', None)
1351
stdin = kwargs.pop('stdin', None)
1352
working_dir = kwargs.pop('working_dir', None)
1353
error_regexes = kwargs.pop('error_regexes', [])
1356
if isinstance(args[0], (list, basestring)):
1359
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1360
DeprecationWarning, stacklevel=3)
1362
out, err = self._run_bzr_autosplit(args=args,
1364
encoding=encoding, stdin=stdin, working_dir=working_dir,
1367
for regex in error_regexes:
1368
self.assertContainsRe(err, regex)
1371
def run_bzr_decode(self, *args, **kwargs):
1372
if 'encoding' in kwargs:
1373
encoding = kwargs['encoding']
1375
encoding = bzrlib.user_encoding
1376
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1378
def run_bzr_error(self, error_regexes, *args, **kwargs):
1379
"""Run bzr, and check that stderr contains the supplied regexes
1381
:param error_regexes: Sequence of regular expressions which
1382
must each be found in the error output. The relative ordering
1384
:param args: command-line arguments for bzr
1385
:param kwargs: Keyword arguments which are interpreted by run_bzr
1386
This function changes the default value of retcode to be 3,
1387
since in most cases this is run when you expect bzr to fail.
1389
:return: (out, err) The actual output of running the command (in case
1390
you want to do more inspection)
1394
# Make sure that commit is failing because there is nothing to do
1395
self.run_bzr_error(['no changes to commit'],
1396
'commit', '-m', 'my commit comment')
1397
# Make sure --strict is handling an unknown file, rather than
1398
# giving us the 'nothing to do' error
1399
self.build_tree(['unknown'])
1400
self.run_bzr_error(['Commit refused because there are unknown files'],
1401
'commit', '--strict', '-m', 'my commit comment')
1403
kwargs.setdefault('retcode', 3)
1404
kwargs['error_regexes'] = error_regexes
1405
out, err = self.run_bzr(*args, **kwargs)
1408
def run_bzr_subprocess(self, *args, **kwargs):
1409
"""Run bzr in a subprocess for testing.
1411
This starts a new Python interpreter and runs bzr in there.
1412
This should only be used for tests that have a justifiable need for
1413
this isolation: e.g. they are testing startup time, or signal
1414
handling, or early startup code, etc. Subprocess code can't be
1415
profiled or debugged so easily.
1417
:keyword retcode: The status code that is expected. Defaults to 0. If
1418
None is supplied, the status code is not checked.
1419
:keyword env_changes: A dictionary which lists changes to environment
1420
variables. A value of None will unset the env variable.
1421
The values must be strings. The change will only occur in the
1422
child, so you don't need to fix the environment after running.
1423
:keyword universal_newlines: Convert CRLF => LF
1424
:keyword allow_plugins: By default the subprocess is run with
1425
--no-plugins to ensure test reproducibility. Also, it is possible
1426
for system-wide plugins to create unexpected output on stderr,
1427
which can cause unnecessary test failures.
1429
env_changes = kwargs.get('env_changes', {})
1430
working_dir = kwargs.get('working_dir', None)
1431
allow_plugins = kwargs.get('allow_plugins', False)
1432
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1433
working_dir=working_dir,
1434
allow_plugins=allow_plugins)
1435
# We distinguish between retcode=None and retcode not passed.
1436
supplied_retcode = kwargs.get('retcode', 0)
1437
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1438
universal_newlines=kwargs.get('universal_newlines', False),
1441
def start_bzr_subprocess(self, process_args, env_changes=None,
1442
skip_if_plan_to_signal=False,
1444
allow_plugins=False):
1445
"""Start bzr in a subprocess for testing.
1447
This starts a new Python interpreter and runs bzr in there.
1448
This should only be used for tests that have a justifiable need for
1449
this isolation: e.g. they are testing startup time, or signal
1450
handling, or early startup code, etc. Subprocess code can't be
1451
profiled or debugged so easily.
1453
:param process_args: a list of arguments to pass to the bzr executable,
1454
for example ``['--version']``.
1455
:param env_changes: A dictionary which lists changes to environment
1456
variables. A value of None will unset the env variable.
1457
The values must be strings. The change will only occur in the
1458
child, so you don't need to fix the environment after running.
1459
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1461
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1463
:returns: Popen object for the started process.
1465
if skip_if_plan_to_signal:
1466
if not getattr(os, 'kill', None):
1467
raise TestSkipped("os.kill not available.")
1469
if env_changes is None:
1473
def cleanup_environment():
1474
for env_var, value in env_changes.iteritems():
1475
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1477
def restore_environment():
1478
for env_var, value in old_env.iteritems():
1479
osutils.set_or_unset_env(env_var, value)
1481
bzr_path = self.get_bzr_path()
1484
if working_dir is not None:
1485
cwd = osutils.getcwd()
1486
os.chdir(working_dir)
1489
# win32 subprocess doesn't support preexec_fn
1490
# so we will avoid using it on all platforms, just to
1491
# make sure the code path is used, and we don't break on win32
1492
cleanup_environment()
1493
command = [sys.executable, bzr_path]
1494
if not allow_plugins:
1495
command.append('--no-plugins')
1496
command.extend(process_args)
1497
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1499
restore_environment()
1505
def _popen(self, *args, **kwargs):
1506
"""Place a call to Popen.
1508
Allows tests to override this method to intercept the calls made to
1509
Popen for introspection.
1511
return Popen(*args, **kwargs)
1513
def get_bzr_path(self):
1514
"""Return the path of the 'bzr' executable for this test suite."""
1515
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1516
if not os.path.isfile(bzr_path):
1517
# We are probably installed. Assume sys.argv is the right file
1518
bzr_path = sys.argv[0]
1521
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1522
universal_newlines=False, process_args=None):
1523
"""Finish the execution of process.
1525
:param process: the Popen object returned from start_bzr_subprocess.
1526
:param retcode: The status code that is expected. Defaults to 0. If
1527
None is supplied, the status code is not checked.
1528
:param send_signal: an optional signal to send to the process.
1529
:param universal_newlines: Convert CRLF => LF
1530
:returns: (stdout, stderr)
1532
if send_signal is not None:
1533
os.kill(process.pid, send_signal)
1534
out, err = process.communicate()
1536
if universal_newlines:
1537
out = out.replace('\r\n', '\n')
1538
err = err.replace('\r\n', '\n')
1540
if retcode is not None and retcode != process.returncode:
1541
if process_args is None:
1542
process_args = "(unknown args)"
1543
mutter('Output of bzr %s:\n%s', process_args, out)
1544
mutter('Error for bzr %s:\n%s', process_args, err)
1545
self.fail('Command bzr %s failed with retcode %s != %s'
1546
% (process_args, retcode, process.returncode))
1549
def check_inventory_shape(self, inv, shape):
1550
"""Compare an inventory to a list of expected names.
1552
Fail if they are not precisely equal.
1555
shape = list(shape) # copy
1556
for path, ie in inv.entries():
1557
name = path.replace('\\', '/')
1558
if ie.kind == 'directory':
1565
self.fail("expected paths not found in inventory: %r" % shape)
1567
self.fail("unexpected paths found in inventory: %r" % extras)
1569
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1570
a_callable=None, *args, **kwargs):
1571
"""Call callable with redirected std io pipes.
1573
Returns the return code."""
1574
if not callable(a_callable):
1575
raise ValueError("a_callable must be callable.")
1577
stdin = StringIO("")
1579
if getattr(self, "_log_file", None) is not None:
1580
stdout = self._log_file
1584
if getattr(self, "_log_file", None is not None):
1585
stderr = self._log_file
1588
real_stdin = sys.stdin
1589
real_stdout = sys.stdout
1590
real_stderr = sys.stderr
1595
return a_callable(*args, **kwargs)
1597
sys.stdout = real_stdout
1598
sys.stderr = real_stderr
1599
sys.stdin = real_stdin
1601
def reduceLockdirTimeout(self):
1602
"""Reduce the default lock timeout for the duration of the test, so that
1603
if LockContention occurs during a test, it does so quickly.
1605
Tests that expect to provoke LockContention errors should call this.
1607
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1609
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1610
self.addCleanup(resetTimeout)
1611
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1614
class TestCaseWithMemoryTransport(TestCase):
1615
"""Common test class for tests that do not need disk resources.
1617
Tests that need disk resources should derive from TestCaseWithTransport.
1619
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1621
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1622
a directory which does not exist. This serves to help ensure test isolation
1623
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1624
must exist. However, TestCaseWithMemoryTransport does not offer local
1625
file defaults for the transport in tests, nor does it obey the command line
1626
override, so tests that accidentally write to the common directory should
1629
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1630
a .bzr directory that stops us ascending higher into the filesystem.
1636
def __init__(self, methodName='runTest'):
1637
# allow test parameterisation after test construction and before test
1638
# execution. Variables that the parameteriser sets need to be
1639
# ones that are not set by setUp, or setUp will trash them.
1640
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1641
self.vfs_transport_factory = default_transport
1642
self.transport_server = None
1643
self.transport_readonly_server = None
1644
self.__vfs_server = None
1646
def get_transport(self, relpath=None):
1647
"""Return a writeable transport.
1649
This transport is for the test scratch space relative to
1652
:param relpath: a path relative to the base url.
1654
t = get_transport(self.get_url(relpath))
1655
self.assertFalse(t.is_readonly())
1658
def get_readonly_transport(self, relpath=None):
1659
"""Return a readonly transport for the test scratch space
1661
This can be used to test that operations which should only need
1662
readonly access in fact do not try to write.
1664
:param relpath: a path relative to the base url.
1666
t = get_transport(self.get_readonly_url(relpath))
1667
self.assertTrue(t.is_readonly())
1670
def create_transport_readonly_server(self):
1671
"""Create a transport server from class defined at init.
1673
This is mostly a hook for daughter classes.
1675
return self.transport_readonly_server()
1677
def get_readonly_server(self):
1678
"""Get the server instance for the readonly transport
1680
This is useful for some tests with specific servers to do diagnostics.
1682
if self.__readonly_server is None:
1683
if self.transport_readonly_server is None:
1684
# readonly decorator requested
1685
# bring up the server
1686
self.__readonly_server = ReadonlyServer()
1687
self.__readonly_server.setUp(self.get_vfs_only_server())
1689
self.__readonly_server = self.create_transport_readonly_server()
1690
self.__readonly_server.setUp(self.get_vfs_only_server())
1691
self.addCleanup(self.__readonly_server.tearDown)
1692
return self.__readonly_server
1694
def get_readonly_url(self, relpath=None):
1695
"""Get a URL for the readonly transport.
1697
This will either be backed by '.' or a decorator to the transport
1698
used by self.get_url()
1699
relpath provides for clients to get a path relative to the base url.
1700
These should only be downwards relative, not upwards.
1702
base = self.get_readonly_server().get_url()
1703
return self._adjust_url(base, relpath)
1705
def get_vfs_only_server(self):
1706
"""Get the vfs only read/write server instance.
1708
This is useful for some tests with specific servers that need
1711
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1712
is no means to override it.
1714
if self.__vfs_server is None:
1715
self.__vfs_server = MemoryServer()
1716
self.__vfs_server.setUp()
1717
self.addCleanup(self.__vfs_server.tearDown)
1718
return self.__vfs_server
1720
def get_server(self):
1721
"""Get the read/write server instance.
1723
This is useful for some tests with specific servers that need
1726
This is built from the self.transport_server factory. If that is None,
1727
then the self.get_vfs_server is returned.
1729
if self.__server is None:
1730
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1731
return self.get_vfs_only_server()
1733
# bring up a decorated means of access to the vfs only server.
1734
self.__server = self.transport_server()
1736
self.__server.setUp(self.get_vfs_only_server())
1737
except TypeError, e:
1738
# This should never happen; the try:Except here is to assist
1739
# developers having to update code rather than seeing an
1740
# uninformative TypeError.
1741
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1742
self.addCleanup(self.__server.tearDown)
1743
return self.__server
1745
def _adjust_url(self, base, relpath):
1746
"""Get a URL (or maybe a path) for the readwrite transport.
1748
This will either be backed by '.' or to an equivalent non-file based
1750
relpath provides for clients to get a path relative to the base url.
1751
These should only be downwards relative, not upwards.
1753
if relpath is not None and relpath != '.':
1754
if not base.endswith('/'):
1756
# XXX: Really base should be a url; we did after all call
1757
# get_url()! But sometimes it's just a path (from
1758
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1759
# to a non-escaped local path.
1760
if base.startswith('./') or base.startswith('/'):
1763
base += urlutils.escape(relpath)
1766
def get_url(self, relpath=None):
1767
"""Get a URL (or maybe a path) for the readwrite transport.
1769
This will either be backed by '.' or to an equivalent non-file based
1771
relpath provides for clients to get a path relative to the base url.
1772
These should only be downwards relative, not upwards.
1774
base = self.get_server().get_url()
1775
return self._adjust_url(base, relpath)
1777
def get_vfs_only_url(self, relpath=None):
1778
"""Get a URL (or maybe a path for the plain old vfs transport.
1780
This will never be a smart protocol. It always has all the
1781
capabilities of the local filesystem, but it might actually be a
1782
MemoryTransport or some other similar virtual filesystem.
1784
This is the backing transport (if any) of the server returned by
1785
get_url and get_readonly_url.
1787
:param relpath: provides for clients to get a path relative to the base
1788
url. These should only be downwards relative, not upwards.
1791
base = self.get_vfs_only_server().get_url()
1792
return self._adjust_url(base, relpath)
1794
def _make_test_root(self):
1795
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1797
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1798
TestCaseWithMemoryTransport.TEST_ROOT = root
1800
# make a fake bzr directory there to prevent any tests propagating
1801
# up onto the source directory's real branch
1802
bzrdir.BzrDir.create_standalone_workingtree(root)
1804
# The same directory is used by all tests, and we're not specifically
1805
# told when all tests are finished. This will do.
1806
atexit.register(_rmtree_temp_dir, root)
1808
def makeAndChdirToTestDir(self):
1809
"""Create a temporary directories for this one test.
1811
This must set self.test_home_dir and self.test_dir and chdir to
1814
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1816
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1817
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1818
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1820
def make_branch(self, relpath, format=None):
1821
"""Create a branch on the transport at relpath."""
1822
repo = self.make_repository(relpath, format=format)
1823
return repo.bzrdir.create_branch()
1825
def make_bzrdir(self, relpath, format=None):
1827
# might be a relative or absolute path
1828
maybe_a_url = self.get_url(relpath)
1829
segments = maybe_a_url.rsplit('/', 1)
1830
t = get_transport(maybe_a_url)
1831
if len(segments) > 1 and segments[-1] not in ('', '.'):
1835
if isinstance(format, basestring):
1836
format = bzrdir.format_registry.make_bzrdir(format)
1837
return format.initialize_on_transport(t)
1838
except errors.UninitializableFormat:
1839
raise TestSkipped("Format %s is not initializable." % format)
1841
def make_repository(self, relpath, shared=False, format=None):
1842
"""Create a repository on our default transport at relpath.
1844
Note that relpath must be a relative path, not a full url.
1846
# FIXME: If you create a remoterepository this returns the underlying
1847
# real format, which is incorrect. Actually we should make sure that
1848
# RemoteBzrDir returns a RemoteRepository.
1849
# maybe mbp 20070410
1850
made_control = self.make_bzrdir(relpath, format=format)
1851
return made_control.create_repository(shared=shared)
1853
def make_branch_and_memory_tree(self, relpath, format=None):
1854
"""Create a branch on the default transport and a MemoryTree for it."""
1855
b = self.make_branch(relpath, format=format)
1856
return memorytree.MemoryTree.create_on_branch(b)
1858
def overrideEnvironmentForTesting(self):
1859
os.environ['HOME'] = self.test_home_dir
1860
os.environ['BZR_HOME'] = self.test_home_dir
1863
super(TestCaseWithMemoryTransport, self).setUp()
1864
self._make_test_root()
1865
_currentdir = os.getcwdu()
1866
def _leaveDirectory():
1867
os.chdir(_currentdir)
1868
self.addCleanup(_leaveDirectory)
1869
self.makeAndChdirToTestDir()
1870
self.overrideEnvironmentForTesting()
1871
self.__readonly_server = None
1872
self.__server = None
1873
self.reduceLockdirTimeout()
1876
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1877
"""Derived class that runs a test within a temporary directory.
1879
This is useful for tests that need to create a branch, etc.
1881
The directory is created in a slightly complex way: for each
1882
Python invocation, a new temporary top-level directory is created.
1883
All test cases create their own directory within that. If the
1884
tests complete successfully, the directory is removed.
1886
:ivar test_base_dir: The path of the top-level directory for this
1887
test, which contains a home directory and a work directory.
1889
:ivar test_home_dir: An initially empty directory under test_base_dir
1890
which is used as $HOME for this test.
1892
:ivar test_dir: A directory under test_base_dir used as the current
1893
directory when the test proper is run.
1896
OVERRIDE_PYTHON = 'python'
1897
use_numbered_dirs = False
1899
def check_file_contents(self, filename, expect):
1900
self.log("check contents of file %s" % filename)
1901
contents = file(filename, 'r').read()
1902
if contents != expect:
1903
self.log("expected: %r" % expect)
1904
self.log("actually: %r" % contents)
1905
self.fail("contents of %s not as expected" % filename)
1907
def makeAndChdirToTestDir(self):
1908
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1910
For TestCaseInTempDir we create a temporary directory based on the test
1911
name and then create two subdirs - test and home under it.
1913
# create a directory within the top level test directory
1914
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1915
# now create test and home directories within this dir
1916
self.test_base_dir = candidate_dir
1917
self.test_home_dir = self.test_base_dir + '/home'
1918
os.mkdir(self.test_home_dir)
1919
self.test_dir = self.test_base_dir + '/work'
1920
os.mkdir(self.test_dir)
1921
os.chdir(self.test_dir)
1922
# put name of test inside
1923
f = file(self.test_base_dir + '/name', 'w')
1928
self.addCleanup(self.deleteTestDir)
1930
def deleteTestDir(self):
1931
os.chdir(self.TEST_ROOT)
1932
_rmtree_temp_dir(self.test_base_dir)
1934
def build_tree(self, shape, line_endings='binary', transport=None):
1935
"""Build a test tree according to a pattern.
1937
shape is a sequence of file specifications. If the final
1938
character is '/', a directory is created.
1940
This assumes that all the elements in the tree being built are new.
1942
This doesn't add anything to a branch.
1944
:param line_endings: Either 'binary' or 'native'
1945
in binary mode, exact contents are written in native mode, the
1946
line endings match the default platform endings.
1947
:param transport: A transport to write to, for building trees on VFS's.
1948
If the transport is readonly or None, "." is opened automatically.
1951
# It's OK to just create them using forward slashes on windows.
1952
if transport is None or transport.is_readonly():
1953
transport = get_transport(".")
1955
self.assert_(isinstance(name, basestring))
1957
transport.mkdir(urlutils.escape(name[:-1]))
1959
if line_endings == 'binary':
1961
elif line_endings == 'native':
1964
raise errors.BzrError(
1965
'Invalid line ending request %r' % line_endings)
1966
content = "contents of %s%s" % (name.encode('utf-8'), end)
1967
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1969
def build_tree_contents(self, shape):
1970
build_tree_contents(shape)
1972
def assertFileEqual(self, content, path):
1973
"""Fail if path does not contain 'content'."""
1974
self.failUnlessExists(path)
1975
f = file(path, 'rb')
1980
self.assertEqualDiff(content, s)
1982
def failUnlessExists(self, path):
1983
"""Fail unless path or paths, which may be abs or relative, exist."""
1984
if not isinstance(path, basestring):
1986
self.failUnlessExists(p)
1988
self.failUnless(osutils.lexists(path),path+" does not exist")
1990
def failIfExists(self, path):
1991
"""Fail if path or paths, which may be abs or relative, exist."""
1992
if not isinstance(path, basestring):
1994
self.failIfExists(p)
1996
self.failIf(osutils.lexists(path),path+" exists")
1998
def assertInWorkingTree(self,path,root_path='.',tree=None):
1999
"""Assert whether path or paths are in the WorkingTree"""
2001
tree = workingtree.WorkingTree.open(root_path)
2002
if not isinstance(path, basestring):
2004
self.assertInWorkingTree(p,tree=tree)
2006
self.assertIsNot(tree.path2id(path), None,
2007
path+' not in working tree.')
2009
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2010
"""Assert whether path or paths are not in the WorkingTree"""
2012
tree = workingtree.WorkingTree.open(root_path)
2013
if not isinstance(path, basestring):
2015
self.assertNotInWorkingTree(p,tree=tree)
2017
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2020
class TestCaseWithTransport(TestCaseInTempDir):
2021
"""A test case that provides get_url and get_readonly_url facilities.
2023
These back onto two transport servers, one for readonly access and one for
2026
If no explicit class is provided for readonly access, a
2027
ReadonlyTransportDecorator is used instead which allows the use of non disk
2028
based read write transports.
2030
If an explicit class is provided for readonly access, that server and the
2031
readwrite one must both define get_url() as resolving to os.getcwd().
2034
def get_vfs_only_server(self):
2035
"""See TestCaseWithMemoryTransport.
2037
This is useful for some tests with specific servers that need
2040
if self.__vfs_server is None:
2041
self.__vfs_server = self.vfs_transport_factory()
2042
self.__vfs_server.setUp()
2043
self.addCleanup(self.__vfs_server.tearDown)
2044
return self.__vfs_server
2046
def make_branch_and_tree(self, relpath, format=None):
2047
"""Create a branch on the transport and a tree locally.
2049
If the transport is not a LocalTransport, the Tree can't be created on
2050
the transport. In that case if the vfs_transport_factory is
2051
LocalURLServer the working tree is created in the local
2052
directory backing the transport, and the returned tree's branch and
2053
repository will also be accessed locally. Otherwise a lightweight
2054
checkout is created and returned.
2056
:param format: The BzrDirFormat.
2057
:returns: the WorkingTree.
2059
# TODO: always use the local disk path for the working tree,
2060
# this obviously requires a format that supports branch references
2061
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2063
b = self.make_branch(relpath, format=format)
2065
return b.bzrdir.create_workingtree()
2066
except errors.NotLocalUrl:
2067
# We can only make working trees locally at the moment. If the
2068
# transport can't support them, then we keep the non-disk-backed
2069
# branch and create a local checkout.
2070
if self.vfs_transport_factory is LocalURLServer:
2071
# the branch is colocated on disk, we cannot create a checkout.
2072
# hopefully callers will expect this.
2073
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2074
return local_controldir.create_workingtree()
2076
return b.create_checkout(relpath, lightweight=True)
2078
def assertIsDirectory(self, relpath, transport):
2079
"""Assert that relpath within transport is a directory.
2081
This may not be possible on all transports; in that case it propagates
2082
a TransportNotPossible.
2085
mode = transport.stat(relpath).st_mode
2086
except errors.NoSuchFile:
2087
self.fail("path %s is not a directory; no such file"
2089
if not stat.S_ISDIR(mode):
2090
self.fail("path %s is not a directory; has mode %#o"
2093
def assertTreesEqual(self, left, right):
2094
"""Check that left and right have the same content and properties."""
2095
# we use a tree delta to check for equality of the content, and we
2096
# manually check for equality of other things such as the parents list.
2097
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2098
differences = left.changes_from(right)
2099
self.assertFalse(differences.has_changed(),
2100
"Trees %r and %r are different: %r" % (left, right, differences))
2103
super(TestCaseWithTransport, self).setUp()
2104
self.__vfs_server = None
2107
class ChrootedTestCase(TestCaseWithTransport):
2108
"""A support class that provides readonly urls outside the local namespace.
2110
This is done by checking if self.transport_server is a MemoryServer. if it
2111
is then we are chrooted already, if it is not then an HttpServer is used
2114
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2115
be used without needed to redo it when a different
2116
subclass is in use ?
2120
super(ChrootedTestCase, self).setUp()
2121
if not self.vfs_transport_factory == MemoryServer:
2122
self.transport_readonly_server = HttpServer
2125
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2126
random_order=False):
2127
"""Create a test suite by filtering another one.
2129
:param suite: the source suite
2130
:param pattern: pattern that names must match
2131
:param exclude_pattern: pattern that names must not match, if any
2132
:param random_order: if True, tests in the new suite will be put in
2134
:returns: the newly created suite
2136
return sort_suite_by_re(suite, pattern, exclude_pattern,
2137
random_order, False)
2140
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2141
random_order=False, append_rest=True):
2142
"""Create a test suite by sorting another one.
2144
:param suite: the source suite
2145
:param pattern: pattern that names must match in order to go
2146
first in the new suite
2147
:param exclude_pattern: pattern that names must not match, if any
2148
:param random_order: if True, tests in the new suite will be put in
2150
:param append_rest: if False, pattern is a strict filter and not
2151
just an ordering directive
2152
:returns: the newly created suite
2156
filter_re = re.compile(pattern)
2157
if exclude_pattern is not None:
2158
exclude_re = re.compile(exclude_pattern)
2159
for test in iter_suite_tests(suite):
2161
if exclude_pattern is None or not exclude_re.search(test_id):
2162
if filter_re.search(test_id):
2167
random.shuffle(first)
2168
random.shuffle(second)
2169
return TestUtil.TestSuite(first + second)
2172
def run_suite(suite, name='test', verbose=False, pattern=".*",
2173
stop_on_failure=False,
2174
transport=None, lsprof_timed=None, bench_history=None,
2175
matching_tests_first=None,
2179
exclude_pattern=None,
2181
use_numbered_dirs = bool(numbered_dirs)
2183
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2184
if numbered_dirs is not None:
2185
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2190
runner = TextTestRunner(stream=sys.stdout,
2192
verbosity=verbosity,
2193
bench_history=bench_history,
2194
use_numbered_dirs=use_numbered_dirs,
2195
list_only=list_only,
2197
runner.stop_on_failure=stop_on_failure
2198
# Initialise the random number generator and display the seed used.
2199
# We convert the seed to a long to make it reuseable across invocations.
2200
random_order = False
2201
if random_seed is not None:
2203
if random_seed == "now":
2204
random_seed = long(time.time())
2206
# Convert the seed to a long if we can
2208
random_seed = long(random_seed)
2211
runner.stream.writeln("Randomizing test order using seed %s\n" %
2213
random.seed(random_seed)
2214
# Customise the list of tests if requested
2215
if pattern != '.*' or exclude_pattern is not None or random_order:
2216
if matching_tests_first:
2217
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2220
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2222
result = runner.run(suite)
143
TestResult.addSuccess(self, test)
148
from unittest import TestLoader, TestSuite
150
import bzrlib.selftest.whitebox
151
import bzrlib.selftest.blackbox
152
from doctest import DocTestSuite
163
for m in bzrlib.selftest.whitebox, :
164
suite.addTest(tl.loadTestsFromModule(m))
166
suite.addTest(bzrlib.selftest.blackbox.suite())
168
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
170
suite.addTest(DocTestSuite(m))
175
_show_results(result)
2223
177
return result.wasSuccessful()
2226
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2228
test_suite_factory=None,
2231
matching_tests_first=None,
2235
exclude_pattern=None):
2236
"""Run the whole test suite under the enhanced runner"""
2237
# XXX: Very ugly way to do this...
2238
# Disable warning about old formats because we don't want it to disturb
2239
# any blackbox tests.
2240
from bzrlib import repository
2241
repository._deprecation_warning_done = True
2243
global default_transport
2244
if transport is None:
2245
transport = default_transport
2246
old_transport = default_transport
2247
default_transport = transport
2249
if test_suite_factory is None:
2250
suite = test_suite()
2252
suite = test_suite_factory()
2253
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2254
stop_on_failure=stop_on_failure,
2255
transport=transport,
2256
lsprof_timed=lsprof_timed,
2257
bench_history=bench_history,
2258
matching_tests_first=matching_tests_first,
2259
numbered_dirs=numbered_dirs,
2260
list_only=list_only,
2261
random_seed=random_seed,
2262
exclude_pattern=exclude_pattern)
2264
default_transport = old_transport
2268
"""Build and return TestSuite for the whole of bzrlib.
2270
This function can be replaced if you need to change the default test
2271
suite on a global basis, but it is not encouraged.
2274
'bzrlib.tests.test_ancestry',
2275
'bzrlib.tests.test_annotate',
2276
'bzrlib.tests.test_api',
2277
'bzrlib.tests.test_atomicfile',
2278
'bzrlib.tests.test_bad_files',
2279
'bzrlib.tests.test_branch',
2280
'bzrlib.tests.test_branchbuilder',
2281
'bzrlib.tests.test_bugtracker',
2282
'bzrlib.tests.test_bundle',
2283
'bzrlib.tests.test_bzrdir',
2284
'bzrlib.tests.test_cache_utf8',
2285
'bzrlib.tests.test_commands',
2286
'bzrlib.tests.test_commit',
2287
'bzrlib.tests.test_commit_merge',
2288
'bzrlib.tests.test_config',
2289
'bzrlib.tests.test_conflicts',
2290
'bzrlib.tests.test_pack',
2291
'bzrlib.tests.test_counted_lock',
2292
'bzrlib.tests.test_decorators',
2293
'bzrlib.tests.test_delta',
2294
'bzrlib.tests.test_deprecated_graph',
2295
'bzrlib.tests.test_diff',
2296
'bzrlib.tests.test_dirstate',
2297
'bzrlib.tests.test_errors',
2298
'bzrlib.tests.test_escaped_store',
2299
'bzrlib.tests.test_extract',
2300
'bzrlib.tests.test_fetch',
2301
'bzrlib.tests.test_ftp_transport',
2302
'bzrlib.tests.test_generate_docs',
2303
'bzrlib.tests.test_generate_ids',
2304
'bzrlib.tests.test_globbing',
2305
'bzrlib.tests.test_gpg',
2306
'bzrlib.tests.test_graph',
2307
'bzrlib.tests.test_hashcache',
2308
'bzrlib.tests.test_help',
2309
'bzrlib.tests.test_hooks',
2310
'bzrlib.tests.test_http',
2311
'bzrlib.tests.test_http_response',
2312
'bzrlib.tests.test_https_ca_bundle',
2313
'bzrlib.tests.test_identitymap',
2314
'bzrlib.tests.test_ignores',
2315
'bzrlib.tests.test_info',
2316
'bzrlib.tests.test_inv',
2317
'bzrlib.tests.test_knit',
2318
'bzrlib.tests.test_lazy_import',
2319
'bzrlib.tests.test_lazy_regex',
2320
'bzrlib.tests.test_lockdir',
2321
'bzrlib.tests.test_lockable_files',
2322
'bzrlib.tests.test_log',
2323
'bzrlib.tests.test_lsprof',
2324
'bzrlib.tests.test_memorytree',
2325
'bzrlib.tests.test_merge',
2326
'bzrlib.tests.test_merge3',
2327
'bzrlib.tests.test_merge_core',
2328
'bzrlib.tests.test_merge_directive',
2329
'bzrlib.tests.test_missing',
2330
'bzrlib.tests.test_msgeditor',
2331
'bzrlib.tests.test_nonascii',
2332
'bzrlib.tests.test_options',
2333
'bzrlib.tests.test_osutils',
2334
'bzrlib.tests.test_osutils_encodings',
2335
'bzrlib.tests.test_patch',
2336
'bzrlib.tests.test_patches',
2337
'bzrlib.tests.test_permissions',
2338
'bzrlib.tests.test_plugins',
2339
'bzrlib.tests.test_progress',
2340
'bzrlib.tests.test_reconcile',
2341
'bzrlib.tests.test_registry',
2342
'bzrlib.tests.test_remote',
2343
'bzrlib.tests.test_repository',
2344
'bzrlib.tests.test_revert',
2345
'bzrlib.tests.test_revision',
2346
'bzrlib.tests.test_revisionnamespaces',
2347
'bzrlib.tests.test_revisiontree',
2348
'bzrlib.tests.test_rio',
2349
'bzrlib.tests.test_sampler',
2350
'bzrlib.tests.test_selftest',
2351
'bzrlib.tests.test_setup',
2352
'bzrlib.tests.test_sftp_transport',
2353
'bzrlib.tests.test_smart',
2354
'bzrlib.tests.test_smart_add',
2355
'bzrlib.tests.test_smart_transport',
2356
'bzrlib.tests.test_smtp_connection',
2357
'bzrlib.tests.test_source',
2358
'bzrlib.tests.test_ssh_transport',
2359
'bzrlib.tests.test_status',
2360
'bzrlib.tests.test_store',
2361
'bzrlib.tests.test_strace',
2362
'bzrlib.tests.test_subsume',
2363
'bzrlib.tests.test_symbol_versioning',
2364
'bzrlib.tests.test_tag',
2365
'bzrlib.tests.test_testament',
2366
'bzrlib.tests.test_textfile',
2367
'bzrlib.tests.test_textmerge',
2368
'bzrlib.tests.test_timestamp',
2369
'bzrlib.tests.test_trace',
2370
'bzrlib.tests.test_transactions',
2371
'bzrlib.tests.test_transform',
2372
'bzrlib.tests.test_transport',
2373
'bzrlib.tests.test_tree',
2374
'bzrlib.tests.test_treebuilder',
2375
'bzrlib.tests.test_tsort',
2376
'bzrlib.tests.test_tuned_gzip',
2377
'bzrlib.tests.test_ui',
2378
'bzrlib.tests.test_upgrade',
2379
'bzrlib.tests.test_urlutils',
2380
'bzrlib.tests.test_versionedfile',
2381
'bzrlib.tests.test_version',
2382
'bzrlib.tests.test_version_info',
2383
'bzrlib.tests.test_weave',
2384
'bzrlib.tests.test_whitebox',
2385
'bzrlib.tests.test_workingtree',
2386
'bzrlib.tests.test_workingtree_4',
2387
'bzrlib.tests.test_wsgi',
2388
'bzrlib.tests.test_xml',
2390
test_transport_implementations = [
2391
'bzrlib.tests.test_transport_implementations',
2392
'bzrlib.tests.test_read_bundle',
2394
suite = TestUtil.TestSuite()
2395
loader = TestUtil.TestLoader()
2396
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2397
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2398
adapter = TransportTestProviderAdapter()
2399
adapt_modules(test_transport_implementations, adapter, loader, suite)
2400
for package in packages_to_test():
2401
suite.addTest(package.test_suite())
2402
for m in MODULES_TO_TEST:
2403
suite.addTest(loader.loadTestsFromModule(m))
2404
for m in MODULES_TO_DOCTEST:
2406
suite.addTest(doctest.DocTestSuite(m))
2407
except ValueError, e:
2408
print '**failed to get doctest for: %s\n%s' %(m,e)
2410
for name, plugin in bzrlib.plugin.all_plugins().items():
2411
if getattr(plugin, 'test_suite', None) is not None:
2412
default_encoding = sys.getdefaultencoding()
2414
plugin_suite = plugin.test_suite()
2415
except ImportError, e:
2416
bzrlib.trace.warning(
2417
'Unable to test plugin "%s": %s', name, e)
2419
suite.addTest(plugin_suite)
2420
if default_encoding != sys.getdefaultencoding():
2421
bzrlib.trace.warning(
2422
'Plugin "%s" tried to reset default encoding to: %s', name,
2423
sys.getdefaultencoding())
2425
sys.setdefaultencoding(default_encoding)
2429
def adapt_modules(mods_list, adapter, loader, suite):
2430
"""Adapt the modules in mods_list using adapter and add to suite."""
2431
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2432
suite.addTests(adapter.adapt(test))
2435
def _rmtree_temp_dir(dirname):
2436
# If LANG=C we probably have created some bogus paths
2437
# which rmtree(unicode) will fail to delete
2438
# so make sure we are using rmtree(str) to delete everything
2439
# except on win32, where rmtree(str) will fail
2440
# since it doesn't have the property of byte-stream paths
2441
# (they are either ascii or mbcs)
2442
if sys.platform == 'win32':
2443
# make sure we are using the unicode win32 api
2444
dirname = unicode(dirname)
2446
dirname = dirname.encode(sys.getfilesystemencoding())
2448
osutils.rmtree(dirname)
2450
if sys.platform == 'win32' and e.errno == errno.EACCES:
2451
print >>sys.stderr, ('Permission denied: '
2452
'unable to remove testing dir '
2453
'%s' % os.path.basename(dirname))
2458
def clean_selftest_output(root=None, quiet=False):
2459
"""Remove all selftest output directories from root directory.
2461
:param root: root directory for clean
2462
(if ommitted or None then clean current directory).
2463
:param quiet: suppress report about deleting directories
2466
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2469
for i in os.listdir(root):
2470
if os.path.isdir(i) and re_dir.match(i):
2472
print 'delete directory:', i
2476
class Feature(object):
2477
"""An operating system Feature."""
2480
self._available = None
2482
def available(self):
2483
"""Is the feature available?
2485
:return: True if the feature is available.
2487
if self._available is None:
2488
self._available = self._probe()
2489
return self._available
2492
"""Implement this method in concrete features.
2494
:return: True if the feature is available.
2496
raise NotImplementedError
2499
if getattr(self, 'feature_name', None):
2500
return self.feature_name()
2501
return self.__class__.__name__
2504
class TestScenarioApplier(object):
2505
"""A tool to apply scenarios to tests."""
2507
def adapt(self, test):
2508
"""Return a TestSuite containing a copy of test for each scenario."""
2509
result = unittest.TestSuite()
2510
for scenario in self.scenarios:
2511
result.addTest(self.adapt_test_to_scenario(test, scenario))
2514
def adapt_test_to_scenario(self, test, scenario):
2515
"""Copy test and apply scenario to it.
2517
:param test: A test to adapt.
2518
:param scenario: A tuple describing the scenarion.
2519
The first element of the tuple is the new test id.
2520
The second element is a dict containing attributes to set on the
2522
:return: The adapted test.
2524
from copy import deepcopy
2525
new_test = deepcopy(test)
2526
for name, value in scenario[1].items():
2527
setattr(new_test, name, value)
2528
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2529
new_test.id = lambda: new_id
180
def _setup_test_log():
184
log_filename = os.path.abspath('testbzr.log')
185
TestBase.TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered
187
print >>TestBase.TEST_LOG, "bzr tests run at " + time.ctime()
188
print '%-30s %s' % ('test log', log_filename)
191
def _setup_test_dir():
195
TestBase.ORIG_DIR = os.getcwdu()
196
TestBase.TEST_ROOT = os.path.abspath("testbzr.tmp")
198
print '%-30s %s' % ('running tests in', TestBase.TEST_ROOT)
200
if os.path.exists(TestBase.TEST_ROOT):
201
shutil.rmtree(TestBase.TEST_ROOT)
202
os.mkdir(TestBase.TEST_ROOT)
203
os.chdir(TestBase.TEST_ROOT)
205
# make a fake bzr directory there to prevent any tests propagating
206
# up onto the source directory's real branch
207
os.mkdir(os.path.join(TestBase.TEST_ROOT, '.bzr'))
211
def _show_results(result):
212
for case, tb in result.errors:
213
_show_test_failure('ERROR', case, tb)
215
for case, tb in result.failures:
216
_show_test_failure('FAILURE', case, tb)
219
print '%4d tests run' % result.testsRun
220
print '%4d errors' % len(result.errors)
221
print '%4d failures' % len(result.failures)
225
def _show_test_failure(kind, case, tb):
226
print (kind + '! ').ljust(60, '-')
229
print ''.ljust(60, '-')
added
removed
bzrlib/selftest/__init__.py
