1
# Copyright (C) 2005, 2006, 2007, 2008 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
18
from testsweet import TestCase, run_suite, InTempDir
65
19
import bzrlib.commands
66
import bzrlib.timestamp
68
import bzrlib.inventory
69
import bzrlib.iterablefile
74
# lsprof not available
76
from bzrlib.merge import merge_inner
80
from bzrlib import symbol_versioning
81
from bzrlib.symbol_versioning import (
88
from bzrlib.transport import get_transport
89
import bzrlib.transport
90
from bzrlib.transport.local import LocalURLServer
91
from bzrlib.transport.memory import MemoryServer
92
from bzrlib.transport.readonly import ReadonlyServer
93
from bzrlib.trace import mutter, note
94
from bzrlib.tests import TestUtil
95
from bzrlib.tests.http_server import HttpServer
96
from bzrlib.tests.TestUtil import (
100
from bzrlib.tests.treeshape import build_tree_contents
101
import bzrlib.version_info_formats.format_custom
102
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
104
# Mark this python module as being part of the implementation
105
# of unittest: this gives us better tracebacks where the last
106
# shown frame is the test code, not our assertXYZ.
109
default_transport = LocalURLServer
112
class ExtendedTestResult(unittest._TextTestResult):
113
"""Accepts, reports and accumulates the results of running tests.
115
Compared to the unittest version this class adds support for
116
profiling, benchmarking, stopping as soon as a test fails, and
117
skipping tests. There are further-specialized subclasses for
118
different types of display.
120
When a test finishes, in whatever way, it calls one of the addSuccess,
121
addFailure or addError classes. These in turn may redirect to a more
122
specific case for the special test results supported by our extended
125
Note that just one of these objects is fed the results from many tests.
130
def __init__(self, stream, descriptions, verbosity,
134
"""Construct new TestResult.
136
:param bench_history: Optionally, a writable file object to accumulate
139
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
140
if bench_history is not None:
141
from bzrlib.version import _get_bzr_source_tree
142
src_tree = _get_bzr_source_tree()
145
revision_id = src_tree.get_parent_ids()[0]
147
# XXX: if this is a brand new tree, do the same as if there
151
# XXX: If there's no branch, what should we do?
153
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
154
self._bench_history = bench_history
155
self.ui = ui.ui_factory
156
self.num_tests = num_tests
158
self.failure_count = 0
159
self.known_failure_count = 0
161
self.not_applicable_count = 0
162
self.unsupported = {}
164
self._overall_start_time = time.time()
166
def _extractBenchmarkTime(self, testCase):
167
"""Add a benchmark time for the current test case."""
168
return getattr(testCase, "_benchtime", None)
170
def _elapsedTestTimeString(self):
171
"""Return a time string for the overall time the current test has taken."""
172
return self._formatTime(time.time() - self._start_time)
174
def _testTimeString(self, testCase):
175
benchmark_time = self._extractBenchmarkTime(testCase)
176
if benchmark_time is not None:
178
self._formatTime(benchmark_time),
179
self._elapsedTestTimeString())
181
return " %s" % self._elapsedTestTimeString()
183
def _formatTime(self, seconds):
184
"""Format seconds as milliseconds with leading spaces."""
185
# some benchmarks can take thousands of seconds to run, so we need 8
187
return "%8dms" % (1000 * seconds)
189
def _shortened_test_description(self, test):
191
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
194
def startTest(self, test):
195
unittest.TestResult.startTest(self, test)
196
self.report_test_start(test)
197
test.number = self.count
198
self._recordTestStartTime()
200
def _recordTestStartTime(self):
201
"""Record that a test has started."""
202
self._start_time = time.time()
204
def _cleanupLogFile(self, test):
205
# We can only do this if we have one of our TestCases, not if
207
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
208
if setKeepLogfile is not None:
211
def addError(self, test, err):
212
"""Tell result that test finished with an error.
214
Called from the TestCase run() method when the test
215
fails with an unexpected error.
217
self._testConcluded(test)
218
if isinstance(err[1], TestSkipped):
219
return self._addSkipped(test, err)
220
elif isinstance(err[1], UnavailableFeature):
221
return self.addNotSupported(test, err[1].args[0])
223
unittest.TestResult.addError(self, test, err)
224
self.error_count += 1
225
self.report_error(test, err)
228
self._cleanupLogFile(test)
230
def addFailure(self, test, err):
231
"""Tell result that test failed.
233
Called from the TestCase run() method when the test
234
fails because e.g. an assert() method failed.
236
self._testConcluded(test)
237
if isinstance(err[1], KnownFailure):
238
return self._addKnownFailure(test, err)
240
unittest.TestResult.addFailure(self, test, err)
241
self.failure_count += 1
242
self.report_failure(test, err)
245
self._cleanupLogFile(test)
247
def addSuccess(self, test):
248
"""Tell result that test completed successfully.
250
Called from the TestCase run()
252
self._testConcluded(test)
253
if self._bench_history is not None:
254
benchmark_time = self._extractBenchmarkTime(test)
255
if benchmark_time is not None:
256
self._bench_history.write("%s %s\n" % (
257
self._formatTime(benchmark_time),
259
self.report_success(test)
260
self._cleanupLogFile(test)
261
unittest.TestResult.addSuccess(self, test)
262
test._log_contents = ''
264
def _testConcluded(self, test):
265
"""Common code when a test has finished.
267
Called regardless of whether it succeded, failed, etc.
271
def _addKnownFailure(self, test, err):
272
self.known_failure_count += 1
273
self.report_known_failure(test, err)
275
def addNotSupported(self, test, feature):
276
"""The test will not be run because of a missing feature.
278
# this can be called in two different ways: it may be that the
279
# test started running, and then raised (through addError)
280
# UnavailableFeature. Alternatively this method can be called
281
# while probing for features before running the tests; in that
282
# case we will see startTest and stopTest, but the test will never
284
self.unsupported.setdefault(str(feature), 0)
285
self.unsupported[str(feature)] += 1
286
self.report_unsupported(test, feature)
288
def _addSkipped(self, test, skip_excinfo):
289
if isinstance(skip_excinfo[1], TestNotApplicable):
290
self.not_applicable_count += 1
291
self.report_not_applicable(test, skip_excinfo)
294
self.report_skip(test, skip_excinfo)
297
except KeyboardInterrupt:
300
self.addError(test, test._exc_info())
302
# seems best to treat this as success from point-of-view of unittest
303
# -- it actually does nothing so it barely matters :)
304
unittest.TestResult.addSuccess(self, test)
305
test._log_contents = ''
307
def printErrorList(self, flavour, errors):
308
for test, err in errors:
309
self.stream.writeln(self.separator1)
310
self.stream.write("%s: " % flavour)
311
self.stream.writeln(self.getDescription(test))
312
if getattr(test, '_get_log', None) is not None:
313
self.stream.write('\n')
315
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
316
self.stream.write('\n')
317
self.stream.write(test._get_log())
318
self.stream.write('\n')
320
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
321
self.stream.write('\n')
322
self.stream.writeln(self.separator2)
323
self.stream.writeln("%s" % err)
328
def report_cleaning_up(self):
331
def report_success(self, test):
334
def wasStrictlySuccessful(self):
335
if self.unsupported or self.known_failure_count:
337
return self.wasSuccessful()
340
class TextTestResult(ExtendedTestResult):
341
"""Displays progress and results of tests in text form"""
343
def __init__(self, stream, descriptions, verbosity,
348
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
349
bench_history, num_tests)
351
self.pb = self.ui.nested_progress_bar()
352
self._supplied_pb = False
355
self._supplied_pb = True
356
self.pb.show_pct = False
357
self.pb.show_spinner = False
358
self.pb.show_eta = False,
359
self.pb.show_count = False
360
self.pb.show_bar = False
362
def report_starting(self):
363
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
365
def _progress_prefix_text(self):
366
# the longer this text, the less space we have to show the test
368
a = '[%d' % self.count # total that have been run
369
# tests skipped as known not to be relevant are not important enough
371
## if self.skip_count:
372
## a += ', %d skip' % self.skip_count
373
## if self.known_failure_count:
374
## a += '+%dX' % self.known_failure_count
375
if self.num_tests is not None:
376
a +='/%d' % self.num_tests
378
runtime = time.time() - self._overall_start_time
380
a += '%dm%ds' % (runtime / 60, runtime % 60)
384
a += ', %d err' % self.error_count
385
if self.failure_count:
386
a += ', %d fail' % self.failure_count
388
a += ', %d missing' % len(self.unsupported)
392
def report_test_start(self, test):
395
self._progress_prefix_text()
397
+ self._shortened_test_description(test))
399
def _test_description(self, test):
400
return self._shortened_test_description(test)
402
def report_error(self, test, err):
403
self.pb.note('ERROR: %s\n %s\n',
404
self._test_description(test),
408
def report_failure(self, test, err):
409
self.pb.note('FAIL: %s\n %s\n',
410
self._test_description(test),
414
def report_known_failure(self, test, err):
415
self.pb.note('XFAIL: %s\n%s\n',
416
self._test_description(test), err[1])
418
def report_skip(self, test, skip_excinfo):
421
def report_not_applicable(self, test, skip_excinfo):
424
def report_unsupported(self, test, feature):
425
"""test cannot be run because feature is missing."""
427
def report_cleaning_up(self):
428
self.pb.update('cleaning up...')
431
if not self._supplied_pb:
435
class VerboseTestResult(ExtendedTestResult):
436
"""Produce long output, with one line per test run plus times"""
438
def _ellipsize_to_right(self, a_string, final_width):
439
"""Truncate and pad a string, keeping the right hand side"""
440
if len(a_string) > final_width:
441
result = '...' + a_string[3-final_width:]
444
return result.ljust(final_width)
446
def report_starting(self):
447
self.stream.write('running %d tests...\n' % self.num_tests)
449
def report_test_start(self, test):
451
name = self._shortened_test_description(test)
452
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
453
# numbers, plus a trailing blank
454
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
return '%s%s' % (indent, err[1])
463
def report_error(self, test, err):
464
self.stream.writeln('ERROR %s\n%s'
465
% (self._testTimeString(test),
466
self._error_summary(err)))
468
def report_failure(self, test, err):
469
self.stream.writeln(' FAIL %s\n%s'
470
% (self._testTimeString(test),
471
self._error_summary(err)))
473
def report_known_failure(self, test, err):
474
self.stream.writeln('XFAIL %s\n%s'
475
% (self._testTimeString(test),
476
self._error_summary(err)))
478
def report_success(self, test):
479
self.stream.writeln(' OK %s' % self._testTimeString(test))
480
for bench_called, stats in getattr(test, '_benchcalls', []):
481
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
482
stats.pprint(file=self.stream)
483
# flush the stream so that we get smooth output. This verbose mode is
484
# used to show the output in PQM.
487
def report_skip(self, test, skip_excinfo):
488
self.stream.writeln(' SKIP %s\n%s'
489
% (self._testTimeString(test),
490
self._error_summary(skip_excinfo)))
492
def report_not_applicable(self, test, skip_excinfo):
493
self.stream.writeln(' N/A %s\n%s'
494
% (self._testTimeString(test),
495
self._error_summary(skip_excinfo)))
497
def report_unsupported(self, test, feature):
498
"""test cannot be run because feature is missing."""
499
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
500
%(self._testTimeString(test), feature))
503
class TextTestRunner(object):
504
stop_on_failure = False
513
self.stream = unittest._WritelnDecorator(stream)
514
self.descriptions = descriptions
515
self.verbosity = verbosity
516
self._bench_history = bench_history
517
self.list_only = list_only
520
"Run the given test case or test suite."
521
startTime = time.time()
522
if self.verbosity == 1:
523
result_class = TextTestResult
524
elif self.verbosity >= 2:
525
result_class = VerboseTestResult
526
result = result_class(self.stream,
529
bench_history=self._bench_history,
530
num_tests=test.countTestCases(),
532
result.stop_early = self.stop_on_failure
533
result.report_starting()
535
if self.verbosity >= 2:
536
self.stream.writeln("Listing tests only ...\n")
538
for t in iter_suite_tests(test):
539
self.stream.writeln("%s" % (t.id()))
541
actionTaken = "Listed"
544
run = result.testsRun
546
stopTime = time.time()
547
timeTaken = stopTime - startTime
549
self.stream.writeln(result.separator2)
550
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
551
run, run != 1 and "s" or "", timeTaken))
552
self.stream.writeln()
553
if not result.wasSuccessful():
554
self.stream.write("FAILED (")
555
failed, errored = map(len, (result.failures, result.errors))
557
self.stream.write("failures=%d" % failed)
559
if failed: self.stream.write(", ")
560
self.stream.write("errors=%d" % errored)
561
if result.known_failure_count:
562
if failed or errored: self.stream.write(", ")
563
self.stream.write("known_failure_count=%d" %
564
result.known_failure_count)
565
self.stream.writeln(")")
567
if result.known_failure_count:
568
self.stream.writeln("OK (known_failures=%d)" %
569
result.known_failure_count)
571
self.stream.writeln("OK")
572
if result.skip_count > 0:
573
skipped = result.skip_count
574
self.stream.writeln('%d test%s skipped' %
575
(skipped, skipped != 1 and "s" or ""))
576
if result.unsupported:
577
for feature, count in sorted(result.unsupported.items()):
578
self.stream.writeln("Missing feature '%s' skipped %d tests." %
584
def iter_suite_tests(suite):
585
"""Return all tests in a suite, recursing through nested suites"""
586
for item in suite._tests:
587
if isinstance(item, unittest.TestCase):
589
elif isinstance(item, unittest.TestSuite):
590
for r in iter_suite_tests(item):
593
raise Exception('unknown object %r inside test suite %r'
597
class TestSkipped(Exception):
598
"""Indicates that a test was intentionally skipped, rather than failing."""
601
class TestNotApplicable(TestSkipped):
602
"""A test is not applicable to the situation where it was run.
604
This is only normally raised by parameterized tests, if they find that
605
the instance they're constructed upon does not support one aspect
610
class KnownFailure(AssertionError):
611
"""Indicates that a test failed in a precisely expected manner.
613
Such failures dont block the whole test suite from passing because they are
614
indicators of partially completed code or of future work. We have an
615
explicit error for them so that we can ensure that they are always visible:
616
KnownFailures are always shown in the output of bzr selftest.
620
class UnavailableFeature(Exception):
621
"""A feature required for this test was not available.
623
The feature should be used to construct the exception.
627
class CommandFailed(Exception):
631
class StringIOWrapper(object):
632
"""A wrapper around cStringIO which just adds an encoding attribute.
634
Internally we can check sys.stdout to see what the output encoding
635
should be. However, cStringIO has no encoding attribute that we can
636
set. So we wrap it instead.
641
def __init__(self, s=None):
643
self.__dict__['_cstring'] = StringIO(s)
645
self.__dict__['_cstring'] = StringIO()
647
def __getattr__(self, name, getattr=getattr):
648
return getattr(self.__dict__['_cstring'], name)
650
def __setattr__(self, name, val):
651
if name == 'encoding':
652
self.__dict__['encoding'] = val
654
return setattr(self._cstring, name, val)
657
class TestUIFactory(ui.CLIUIFactory):
658
"""A UI Factory for testing.
660
Hide the progress bar but emit note()s.
662
Allows get_password to be tested without real tty attached.
669
super(TestUIFactory, self).__init__()
670
if stdin is not None:
671
# We use a StringIOWrapper to be able to test various
672
# encodings, but the user is still responsible to
673
# encode the string and to set the encoding attribute
674
# of StringIOWrapper.
675
self.stdin = StringIOWrapper(stdin)
677
self.stdout = sys.stdout
681
self.stderr = sys.stderr
686
"""See progress.ProgressBar.clear()."""
688
def clear_term(self):
689
"""See progress.ProgressBar.clear_term()."""
691
def clear_term(self):
692
"""See progress.ProgressBar.clear_term()."""
695
"""See progress.ProgressBar.finished()."""
697
def note(self, fmt_string, *args, **kwargs):
698
"""See progress.ProgressBar.note()."""
699
self.stdout.write((fmt_string + "\n") % args)
701
def progress_bar(self):
704
def nested_progress_bar(self):
707
def update(self, message, count=None, total=None):
708
"""See progress.ProgressBar.update()."""
710
def get_non_echoed_password(self, prompt):
711
"""Get password from stdin without trying to handle the echo mode"""
713
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
714
password = self.stdin.readline()
717
if password[-1] == '\n':
718
password = password[:-1]
722
def _report_leaked_threads():
723
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
724
TestCase._first_thread_leaker_id,
725
TestCase._leaking_threads_tests)
728
class TestCase(unittest.TestCase):
729
"""Base class for bzr unit tests.
731
Tests that need access to disk resources should subclass
732
TestCaseInTempDir not TestCase.
734
Error and debug log messages are redirected from their usual
735
location into a temporary file, the contents of which can be
736
retrieved by _get_log(). We use a real OS file, not an in-memory object,
737
so that it can also capture file IO. When the test completes this file
738
is read into memory and removed from disk.
740
There are also convenience functions to invoke bzr's command-line
741
routine, and to build and check bzr trees.
743
In addition to the usual method of overriding tearDown(), this class also
744
allows subclasses to register functions into the _cleanups list, which is
745
run in order as the object is torn down. It's less likely this will be
746
accidentally overlooked.
749
_active_threads = None
750
_leaking_threads_tests = 0
751
_first_thread_leaker_id = None
752
_log_file_name = None
754
_keep_log_file = False
755
# record lsprof data when performing benchmark calls.
756
_gather_lsprof_in_benchmarks = False
757
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
758
'_log_contents', '_log_file_name', '_benchtime',
759
'_TestCase__testMethodName')
761
def __init__(self, methodName='testMethod'):
762
super(TestCase, self).__init__(methodName)
766
unittest.TestCase.setUp(self)
767
self._cleanEnvironment()
770
self._benchcalls = []
771
self._benchtime = None
773
self._clear_debug_flags()
774
TestCase._active_threads = threading.activeCount()
775
self.addCleanup(self._check_leaked_threads)
777
def _check_leaked_threads(self):
778
active = threading.activeCount()
779
leaked_threads = active - TestCase._active_threads
780
TestCase._active_threads = active
782
TestCase._leaking_threads_tests += 1
783
if TestCase._first_thread_leaker_id is None:
784
TestCase._first_thread_leaker_id = self.id()
785
# we're not specifically told when all tests are finished.
786
# This will do. We use a function to avoid keeping a reference
787
# to a TestCase object.
788
atexit.register(_report_leaked_threads)
790
def _clear_debug_flags(self):
791
"""Prevent externally set debug flags affecting tests.
793
Tests that want to use debug flags can just set them in the
794
debug_flags set during setup/teardown.
796
self._preserved_debug_flags = set(debug.debug_flags)
797
if 'allow_debug' not in selftest_debug_flags:
798
debug.debug_flags.clear()
799
self.addCleanup(self._restore_debug_flags)
801
def _clear_hooks(self):
802
# prevent hooks affecting tests
804
import bzrlib.smart.client
805
import bzrlib.smart.server
806
self._preserved_hooks = {
807
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
808
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
809
bzrlib.smart.client._SmartClient: bzrlib.smart.client._SmartClient.hooks,
810
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
812
self.addCleanup(self._restoreHooks)
813
# reset all hooks to an empty instance of the appropriate type
814
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
815
bzrlib.smart.client._SmartClient.hooks = bzrlib.smart.client.SmartClientHooks()
816
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
818
def _silenceUI(self):
819
"""Turn off UI for duration of test"""
820
# by default the UI is off; tests can turn it on if they want it.
821
saved = ui.ui_factory
823
ui.ui_factory = saved
824
ui.ui_factory = ui.SilentUIFactory()
825
self.addCleanup(_restore)
827
def _ndiff_strings(self, a, b):
828
"""Return ndiff between two strings containing lines.
830
A trailing newline is added if missing to make the strings
832
if b and b[-1] != '\n':
834
if a and a[-1] != '\n':
836
difflines = difflib.ndiff(a.splitlines(True),
838
linejunk=lambda x: False,
839
charjunk=lambda x: False)
840
return ''.join(difflines)
842
def assertEqual(self, a, b, message=''):
846
except UnicodeError, e:
847
# If we can't compare without getting a UnicodeError, then
848
# obviously they are different
849
mutter('UnicodeError: %s', e)
852
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
854
pformat(a), pformat(b)))
856
assertEquals = assertEqual
858
def assertEqualDiff(self, a, b, message=None):
859
"""Assert two texts are equal, if not raise an exception.
861
This is intended for use with multi-line strings where it can
862
be hard to find the differences by eye.
864
# TODO: perhaps override assertEquals to call this for strings?
868
message = "texts not equal:\n"
870
message = 'first string is missing a final newline.\n'
872
message = 'second string is missing a final newline.\n'
873
raise AssertionError(message +
874
self._ndiff_strings(a, b))
876
def assertEqualMode(self, mode, mode_test):
877
self.assertEqual(mode, mode_test,
878
'mode mismatch %o != %o' % (mode, mode_test))
880
def assertEqualStat(self, expected, actual):
881
"""assert that expected and actual are the same stat result.
883
:param expected: A stat result.
884
:param actual: A stat result.
885
:raises AssertionError: If the expected and actual stat values differ
888
self.assertEqual(expected.st_size, actual.st_size)
889
self.assertEqual(expected.st_mtime, actual.st_mtime)
890
self.assertEqual(expected.st_ctime, actual.st_ctime)
891
self.assertEqual(expected.st_dev, actual.st_dev)
892
self.assertEqual(expected.st_ino, actual.st_ino)
893
self.assertEqual(expected.st_mode, actual.st_mode)
895
def assertPositive(self, val):
896
"""Assert that val is greater than 0."""
897
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
899
def assertNegative(self, val):
900
"""Assert that val is less than 0."""
901
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
903
def assertStartsWith(self, s, prefix):
904
if not s.startswith(prefix):
905
raise AssertionError('string %r does not start with %r' % (s, prefix))
907
def assertEndsWith(self, s, suffix):
908
"""Asserts that s ends with suffix."""
909
if not s.endswith(suffix):
910
raise AssertionError('string %r does not end with %r' % (s, suffix))
912
def assertContainsRe(self, haystack, needle_re):
913
"""Assert that a contains something matching a regular expression."""
914
if not re.search(needle_re, haystack):
915
if '\n' in haystack or len(haystack) > 60:
916
# a long string, format it in a more readable way
917
raise AssertionError(
918
'pattern "%s" not found in\n"""\\\n%s"""\n'
919
% (needle_re, haystack))
921
raise AssertionError('pattern "%s" not found in "%s"'
922
% (needle_re, haystack))
924
def assertNotContainsRe(self, haystack, needle_re):
925
"""Assert that a does not match a regular expression"""
926
if re.search(needle_re, haystack):
927
raise AssertionError('pattern "%s" found in "%s"'
928
% (needle_re, haystack))
930
def assertSubset(self, sublist, superlist):
931
"""Assert that every entry in sublist is present in superlist."""
932
missing = set(sublist) - set(superlist)
934
raise AssertionError("value(s) %r not present in container %r" %
935
(missing, superlist))
937
def assertListRaises(self, excClass, func, *args, **kwargs):
938
"""Fail unless excClass is raised when the iterator from func is used.
940
Many functions can return generators this makes sure
941
to wrap them in a list() call to make sure the whole generator
942
is run, and that the proper exception is raised.
945
list(func(*args, **kwargs))
949
if getattr(excClass,'__name__', None) is not None:
950
excName = excClass.__name__
952
excName = str(excClass)
953
raise self.failureException, "%s not raised" % excName
955
def assertRaises(self, excClass, callableObj, *args, **kwargs):
956
"""Assert that a callable raises a particular exception.
958
:param excClass: As for the except statement, this may be either an
959
exception class, or a tuple of classes.
960
:param callableObj: A callable, will be passed ``*args`` and
963
Returns the exception so that you can examine it.
966
callableObj(*args, **kwargs)
970
if getattr(excClass,'__name__', None) is not None:
971
excName = excClass.__name__
974
excName = str(excClass)
975
raise self.failureException, "%s not raised" % excName
977
def assertIs(self, left, right, message=None):
978
if not (left is right):
979
if message is not None:
980
raise AssertionError(message)
982
raise AssertionError("%r is not %r." % (left, right))
984
def assertIsNot(self, left, right, message=None):
986
if message is not None:
987
raise AssertionError(message)
989
raise AssertionError("%r is %r." % (left, right))
991
def assertTransportMode(self, transport, path, mode):
992
"""Fail if a path does not have mode mode.
994
If modes are not supported on this transport, the assertion is ignored.
996
if not transport._can_roundtrip_unix_modebits():
998
path_stat = transport.stat(path)
999
actual_mode = stat.S_IMODE(path_stat.st_mode)
1000
self.assertEqual(mode, actual_mode,
1001
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1003
def assertIsSameRealPath(self, path1, path2):
1004
"""Fail if path1 and path2 points to different files"""
1005
self.assertEqual(osutils.realpath(path1),
1006
osutils.realpath(path2),
1007
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1009
def assertIsInstance(self, obj, kls):
1010
"""Fail if obj is not an instance of kls"""
1011
if not isinstance(obj, kls):
1012
self.fail("%r is an instance of %s rather than %s" % (
1013
obj, obj.__class__, kls))
1015
def expectFailure(self, reason, assertion, *args, **kwargs):
1016
"""Invoke a test, expecting it to fail for the given reason.
1018
This is for assertions that ought to succeed, but currently fail.
1019
(The failure is *expected* but not *wanted*.) Please be very precise
1020
about the failure you're expecting. If a new bug is introduced,
1021
AssertionError should be raised, not KnownFailure.
1023
Frequently, expectFailure should be followed by an opposite assertion.
1026
Intended to be used with a callable that raises AssertionError as the
1027
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1029
Raises KnownFailure if the test fails. Raises AssertionError if the
1034
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1036
self.assertEqual(42, dynamic_val)
1038
This means that a dynamic_val of 54 will cause the test to raise
1039
a KnownFailure. Once math is fixed and the expectFailure is removed,
1040
only a dynamic_val of 42 will allow the test to pass. Anything other
1041
than 54 or 42 will cause an AssertionError.
1044
assertion(*args, **kwargs)
1045
except AssertionError:
1046
raise KnownFailure(reason)
1048
self.fail('Unexpected success. Should have failed: %s' % reason)
1050
def assertFileEqual(self, content, path):
1051
"""Fail if path does not contain 'content'."""
1052
self.failUnlessExists(path)
1053
f = file(path, 'rb')
1058
self.assertEqualDiff(content, s)
1060
def failUnlessExists(self, path):
1061
"""Fail unless path or paths, which may be abs or relative, exist."""
1062
if not isinstance(path, basestring):
1064
self.failUnlessExists(p)
1066
self.failUnless(osutils.lexists(path),path+" does not exist")
1068
def failIfExists(self, path):
1069
"""Fail if path or paths, which may be abs or relative, exist."""
1070
if not isinstance(path, basestring):
1072
self.failIfExists(p)
1074
self.failIf(osutils.lexists(path),path+" exists")
1076
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1077
"""A helper for callDeprecated and applyDeprecated.
1079
:param a_callable: A callable to call.
1080
:param args: The positional arguments for the callable
1081
:param kwargs: The keyword arguments for the callable
1082
:return: A tuple (warnings, result). result is the result of calling
1083
a_callable(``*args``, ``**kwargs``).
1086
def capture_warnings(msg, cls=None, stacklevel=None):
1087
# we've hooked into a deprecation specific callpath,
1088
# only deprecations should getting sent via it.
1089
self.assertEqual(cls, DeprecationWarning)
1090
local_warnings.append(msg)
1091
original_warning_method = symbol_versioning.warn
1092
symbol_versioning.set_warning_method(capture_warnings)
1094
result = a_callable(*args, **kwargs)
1096
symbol_versioning.set_warning_method(original_warning_method)
1097
return (local_warnings, result)
1099
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1100
"""Call a deprecated callable without warning the user.
1102
Note that this only captures warnings raised by symbol_versioning.warn,
1103
not other callers that go direct to the warning module.
1105
To test that a deprecated method raises an error, do something like
1108
self.assertRaises(errors.ReservedId,
1109
self.applyDeprecated,
1110
deprecated_in((1, 5, 0)),
1114
:param deprecation_format: The deprecation format that the callable
1115
should have been deprecated with. This is the same type as the
1116
parameter to deprecated_method/deprecated_function. If the
1117
callable is not deprecated with this format, an assertion error
1119
:param a_callable: A callable to call. This may be a bound method or
1120
a regular function. It will be called with ``*args`` and
1122
:param args: The positional arguments for the callable
1123
:param kwargs: The keyword arguments for the callable
1124
:return: The result of a_callable(``*args``, ``**kwargs``)
1126
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1128
expected_first_warning = symbol_versioning.deprecation_string(
1129
a_callable, deprecation_format)
1130
if len(call_warnings) == 0:
1131
self.fail("No deprecation warning generated by call to %s" %
1133
self.assertEqual(expected_first_warning, call_warnings[0])
1136
def callCatchWarnings(self, fn, *args, **kw):
1137
"""Call a callable that raises python warnings.
1139
The caller's responsible for examining the returned warnings.
1141
If the callable raises an exception, the exception is not
1142
caught and propagates up to the caller. In that case, the list
1143
of warnings is not available.
1145
:returns: ([warning_object, ...], fn_result)
1147
# XXX: This is not perfect, because it completely overrides the
1148
# warnings filters, and some code may depend on suppressing particular
1149
# warnings. It's the easiest way to insulate ourselves from -Werror,
1150
# though. -- Andrew, 20071062
1152
def _catcher(message, category, filename, lineno, file=None, line=None):
1153
# despite the name, 'message' is normally(?) a Warning subclass
1155
wlist.append(message)
1156
saved_showwarning = warnings.showwarning
1157
saved_filters = warnings.filters
1159
warnings.showwarning = _catcher
1160
warnings.filters = []
1161
result = fn(*args, **kw)
1163
warnings.showwarning = saved_showwarning
1164
warnings.filters = saved_filters
1165
return wlist, result
1167
def callDeprecated(self, expected, callable, *args, **kwargs):
1168
"""Assert that a callable is deprecated in a particular way.
1170
This is a very precise test for unusual requirements. The
1171
applyDeprecated helper function is probably more suited for most tests
1172
as it allows you to simply specify the deprecation format being used
1173
and will ensure that that is issued for the function being called.
1175
Note that this only captures warnings raised by symbol_versioning.warn,
1176
not other callers that go direct to the warning module. To catch
1177
general warnings, use callCatchWarnings.
1179
:param expected: a list of the deprecation warnings expected, in order
1180
:param callable: The callable to call
1181
:param args: The positional arguments for the callable
1182
:param kwargs: The keyword arguments for the callable
1184
call_warnings, result = self._capture_deprecation_warnings(callable,
1186
self.assertEqual(expected, call_warnings)
1189
def _startLogFile(self):
1190
"""Send bzr and test log messages to a temporary file.
1192
The file is removed as the test is torn down.
1194
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1195
self._log_file = os.fdopen(fileno, 'w+')
1196
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1197
self._log_file_name = name
1198
self.addCleanup(self._finishLogFile)
1200
def _finishLogFile(self):
1201
"""Finished with the log file.
1203
Close the file and delete it, unless setKeepLogfile was called.
1205
if self._log_file is None:
1207
bzrlib.trace.pop_log_file(self._log_memento)
1208
self._log_file.close()
1209
self._log_file = None
1210
if not self._keep_log_file:
1211
os.remove(self._log_file_name)
1212
self._log_file_name = None
1214
def setKeepLogfile(self):
1215
"""Make the logfile not be deleted when _finishLogFile is called."""
1216
self._keep_log_file = True
1218
def addCleanup(self, callable, *args, **kwargs):
1219
"""Arrange to run a callable when this case is torn down.
1221
Callables are run in the reverse of the order they are registered,
1222
ie last-in first-out.
1224
self._cleanups.append((callable, args, kwargs))
1226
def _cleanEnvironment(self):
1228
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1229
'HOME': os.getcwd(),
1230
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1231
# tests do check our impls match APPDATA
1232
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1234
'BZREMAIL': None, # may still be present in the environment
1236
'BZR_PROGRESS_BAR': None,
1239
'SSH_AUTH_SOCK': None,
1243
'https_proxy': None,
1244
'HTTPS_PROXY': None,
1249
# Nobody cares about these ones AFAIK. So far at
1250
# least. If you do (care), please update this comment
1254
'BZR_REMOTE_PATH': None,
1257
self.addCleanup(self._restoreEnvironment)
1258
for name, value in new_env.iteritems():
1259
self._captureVar(name, value)
1261
def _captureVar(self, name, newvalue):
1262
"""Set an environment variable, and reset it when finished."""
1263
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1265
def _restore_debug_flags(self):
1266
debug.debug_flags.clear()
1267
debug.debug_flags.update(self._preserved_debug_flags)
1269
def _restoreEnvironment(self):
1270
for name, value in self.__old_env.iteritems():
1271
osutils.set_or_unset_env(name, value)
1273
def _restoreHooks(self):
1274
for klass, hooks in self._preserved_hooks.items():
1275
setattr(klass, 'hooks', hooks)
1277
def knownFailure(self, reason):
1278
"""This test has failed for some known reason."""
1279
raise KnownFailure(reason)
1281
def run(self, result=None):
1282
if result is None: result = self.defaultTestResult()
1283
for feature in getattr(self, '_test_needs_features', []):
1284
if not feature.available():
1285
result.startTest(self)
1286
if getattr(result, 'addNotSupported', None):
1287
result.addNotSupported(self, feature)
1289
result.addSuccess(self)
1290
result.stopTest(self)
1293
return unittest.TestCase.run(self, result)
1296
absent_attr = object()
1297
for attr_name in self.attrs_to_keep:
1298
attr = getattr(self, attr_name, absent_attr)
1299
if attr is not absent_attr:
1300
saved_attrs[attr_name] = attr
1301
self.__dict__ = saved_attrs
1305
unittest.TestCase.tearDown(self)
1307
def time(self, callable, *args, **kwargs):
1308
"""Run callable and accrue the time it takes to the benchmark time.
1310
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1311
this will cause lsprofile statistics to be gathered and stored in
1314
if self._benchtime is None:
1318
if not self._gather_lsprof_in_benchmarks:
1319
return callable(*args, **kwargs)
1321
# record this benchmark
1322
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1324
self._benchcalls.append(((callable, args, kwargs), stats))
1327
self._benchtime += time.time() - start
1329
def _runCleanups(self):
1330
"""Run registered cleanup functions.
1332
This should only be called from TestCase.tearDown.
1334
# TODO: Perhaps this should keep running cleanups even if
1335
# one of them fails?
1337
# Actually pop the cleanups from the list so tearDown running
1338
# twice is safe (this happens for skipped tests).
1339
while self._cleanups:
1340
cleanup, args, kwargs = self._cleanups.pop()
1341
cleanup(*args, **kwargs)
1343
def log(self, *args):
1346
def _get_log(self, keep_log_file=False):
1347
"""Get the log from bzrlib.trace calls from this test.
1349
:param keep_log_file: When True, if the log is still a file on disk
1350
leave it as a file on disk. When False, if the log is still a file
1351
on disk, the log file is deleted and the log preserved as
1353
:return: A string containing the log.
1355
# flush the log file, to get all content
1357
if bzrlib.trace._trace_file:
1358
bzrlib.trace._trace_file.flush()
1359
if self._log_contents:
1360
# XXX: this can hardly contain the content flushed above --vila
1362
return self._log_contents
1363
if self._log_file_name is not None:
1364
logfile = open(self._log_file_name)
1366
log_contents = logfile.read()
1369
if not keep_log_file:
1370
self._log_contents = log_contents
1372
os.remove(self._log_file_name)
1374
if sys.platform == 'win32' and e.errno == errno.EACCES:
1375
sys.stderr.write(('Unable to delete log file '
1376
' %r\n' % self._log_file_name))
1381
return "DELETED log file to reduce memory footprint"
1383
def requireFeature(self, feature):
1384
"""This test requires a specific feature is available.
1386
:raises UnavailableFeature: When feature is not available.
1388
if not feature.available():
1389
raise UnavailableFeature(feature)
1391
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1393
"""Run bazaar command line, splitting up a string command line."""
1394
if isinstance(args, basestring):
1395
# shlex don't understand unicode strings,
1396
# so args should be plain string (bialix 20070906)
1397
args = list(shlex.split(str(args)))
1398
return self._run_bzr_core(args, retcode=retcode,
1399
encoding=encoding, stdin=stdin, working_dir=working_dir,
1402
def _run_bzr_core(self, args, retcode, encoding, stdin,
1404
if encoding is None:
1405
encoding = osutils.get_user_encoding()
1406
stdout = StringIOWrapper()
1407
stderr = StringIOWrapper()
1408
stdout.encoding = encoding
1409
stderr.encoding = encoding
1411
self.log('run bzr: %r', args)
1412
# FIXME: don't call into logging here
1413
handler = logging.StreamHandler(stderr)
1414
handler.setLevel(logging.INFO)
1415
logger = logging.getLogger('')
1416
logger.addHandler(handler)
1417
old_ui_factory = ui.ui_factory
1418
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1421
if working_dir is not None:
1422
cwd = osutils.getcwd()
1423
os.chdir(working_dir)
1426
result = self.apply_redirected(ui.ui_factory.stdin,
1428
bzrlib.commands.run_bzr_catch_user_errors,
1431
logger.removeHandler(handler)
1432
ui.ui_factory = old_ui_factory
1436
out = stdout.getvalue()
1437
err = stderr.getvalue()
1439
self.log('output:\n%r', out)
1441
self.log('errors:\n%r', err)
1442
if retcode is not None:
1443
self.assertEquals(retcode, result,
1444
message='Unexpected return code')
1447
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1448
working_dir=None, error_regexes=[], output_encoding=None):
1449
"""Invoke bzr, as if it were run from the command line.
1451
The argument list should not include the bzr program name - the
1452
first argument is normally the bzr command. Arguments may be
1453
passed in three ways:
1455
1- A list of strings, eg ["commit", "a"]. This is recommended
1456
when the command contains whitespace or metacharacters, or
1457
is built up at run time.
1459
2- A single string, eg "add a". This is the most convenient
1460
for hardcoded commands.
1462
This runs bzr through the interface that catches and reports
1463
errors, and with logging set to something approximating the
1464
default, so that error reporting can be checked.
1466
This should be the main method for tests that want to exercise the
1467
overall behavior of the bzr application (rather than a unit test
1468
or a functional test of the library.)
1470
This sends the stdout/stderr results into the test's log,
1471
where it may be useful for debugging. See also run_captured.
1473
:keyword stdin: A string to be used as stdin for the command.
1474
:keyword retcode: The status code the command should return;
1476
:keyword working_dir: The directory to run the command in
1477
:keyword error_regexes: A list of expected error messages. If
1478
specified they must be seen in the error output of the command.
1480
out, err = self._run_bzr_autosplit(
1485
working_dir=working_dir,
1487
for regex in error_regexes:
1488
self.assertContainsRe(err, regex)
1491
def run_bzr_error(self, error_regexes, *args, **kwargs):
1492
"""Run bzr, and check that stderr contains the supplied regexes
1494
:param error_regexes: Sequence of regular expressions which
1495
must each be found in the error output. The relative ordering
1497
:param args: command-line arguments for bzr
1498
:param kwargs: Keyword arguments which are interpreted by run_bzr
1499
This function changes the default value of retcode to be 3,
1500
since in most cases this is run when you expect bzr to fail.
1502
:return: (out, err) The actual output of running the command (in case
1503
you want to do more inspection)
1507
# Make sure that commit is failing because there is nothing to do
1508
self.run_bzr_error(['no changes to commit'],
1509
['commit', '-m', 'my commit comment'])
1510
# Make sure --strict is handling an unknown file, rather than
1511
# giving us the 'nothing to do' error
1512
self.build_tree(['unknown'])
1513
self.run_bzr_error(['Commit refused because there are unknown files'],
1514
['commit', --strict', '-m', 'my commit comment'])
1516
kwargs.setdefault('retcode', 3)
1517
kwargs['error_regexes'] = error_regexes
1518
out, err = self.run_bzr(*args, **kwargs)
1521
def run_bzr_subprocess(self, *args, **kwargs):
1522
"""Run bzr in a subprocess for testing.
1524
This starts a new Python interpreter and runs bzr in there.
1525
This should only be used for tests that have a justifiable need for
1526
this isolation: e.g. they are testing startup time, or signal
1527
handling, or early startup code, etc. Subprocess code can't be
1528
profiled or debugged so easily.
1530
:keyword retcode: The status code that is expected. Defaults to 0. If
1531
None is supplied, the status code is not checked.
1532
:keyword env_changes: A dictionary which lists changes to environment
1533
variables. A value of None will unset the env variable.
1534
The values must be strings. The change will only occur in the
1535
child, so you don't need to fix the environment after running.
1536
:keyword universal_newlines: Convert CRLF => LF
1537
:keyword allow_plugins: By default the subprocess is run with
1538
--no-plugins to ensure test reproducibility. Also, it is possible
1539
for system-wide plugins to create unexpected output on stderr,
1540
which can cause unnecessary test failures.
1542
env_changes = kwargs.get('env_changes', {})
1543
working_dir = kwargs.get('working_dir', None)
1544
allow_plugins = kwargs.get('allow_plugins', False)
1546
if isinstance(args[0], list):
1548
elif isinstance(args[0], basestring):
1549
args = list(shlex.split(args[0]))
1551
raise ValueError("passing varargs to run_bzr_subprocess")
1552
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1553
working_dir=working_dir,
1554
allow_plugins=allow_plugins)
1555
# We distinguish between retcode=None and retcode not passed.
1556
supplied_retcode = kwargs.get('retcode', 0)
1557
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1558
universal_newlines=kwargs.get('universal_newlines', False),
1561
def start_bzr_subprocess(self, process_args, env_changes=None,
1562
skip_if_plan_to_signal=False,
1564
allow_plugins=False):
1565
"""Start bzr in a subprocess for testing.
1567
This starts a new Python interpreter and runs bzr in there.
1568
This should only be used for tests that have a justifiable need for
1569
this isolation: e.g. they are testing startup time, or signal
1570
handling, or early startup code, etc. Subprocess code can't be
1571
profiled or debugged so easily.
1573
:param process_args: a list of arguments to pass to the bzr executable,
1574
for example ``['--version']``.
1575
:param env_changes: A dictionary which lists changes to environment
1576
variables. A value of None will unset the env variable.
1577
The values must be strings. The change will only occur in the
1578
child, so you don't need to fix the environment after running.
1579
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1581
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1583
:returns: Popen object for the started process.
1585
if skip_if_plan_to_signal:
1586
if not getattr(os, 'kill', None):
1587
raise TestSkipped("os.kill not available.")
1589
if env_changes is None:
1593
def cleanup_environment():
1594
for env_var, value in env_changes.iteritems():
1595
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1597
def restore_environment():
1598
for env_var, value in old_env.iteritems():
1599
osutils.set_or_unset_env(env_var, value)
1601
bzr_path = self.get_bzr_path()
1604
if working_dir is not None:
1605
cwd = osutils.getcwd()
1606
os.chdir(working_dir)
1609
# win32 subprocess doesn't support preexec_fn
1610
# so we will avoid using it on all platforms, just to
1611
# make sure the code path is used, and we don't break on win32
1612
cleanup_environment()
1613
command = [sys.executable]
1614
# frozen executables don't need the path to bzr
1615
if getattr(sys, "frozen", None) is None:
1616
command.append(bzr_path)
1617
if not allow_plugins:
1618
command.append('--no-plugins')
1619
command.extend(process_args)
1620
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1622
restore_environment()
1628
def _popen(self, *args, **kwargs):
1629
"""Place a call to Popen.
1631
Allows tests to override this method to intercept the calls made to
1632
Popen for introspection.
1634
return Popen(*args, **kwargs)
1636
def get_bzr_path(self):
1637
"""Return the path of the 'bzr' executable for this test suite."""
1638
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1639
if not os.path.isfile(bzr_path):
1640
# We are probably installed. Assume sys.argv is the right file
1641
bzr_path = sys.argv[0]
1644
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1645
universal_newlines=False, process_args=None):
1646
"""Finish the execution of process.
1648
:param process: the Popen object returned from start_bzr_subprocess.
1649
:param retcode: The status code that is expected. Defaults to 0. If
1650
None is supplied, the status code is not checked.
1651
:param send_signal: an optional signal to send to the process.
1652
:param universal_newlines: Convert CRLF => LF
1653
:returns: (stdout, stderr)
1655
if send_signal is not None:
1656
os.kill(process.pid, send_signal)
1657
out, err = process.communicate()
1659
if universal_newlines:
1660
out = out.replace('\r\n', '\n')
1661
err = err.replace('\r\n', '\n')
1663
if retcode is not None and retcode != process.returncode:
1664
if process_args is None:
1665
process_args = "(unknown args)"
1666
mutter('Output of bzr %s:\n%s', process_args, out)
1667
mutter('Error for bzr %s:\n%s', process_args, err)
1668
self.fail('Command bzr %s failed with retcode %s != %s'
1669
% (process_args, retcode, process.returncode))
1672
def check_inventory_shape(self, inv, shape):
1673
"""Compare an inventory to a list of expected names.
1675
Fail if they are not precisely equal.
1678
shape = list(shape) # copy
1679
for path, ie in inv.entries():
1680
name = path.replace('\\', '/')
1681
if ie.kind == 'directory':
1688
self.fail("expected paths not found in inventory: %r" % shape)
1690
self.fail("unexpected paths found in inventory: %r" % extras)
1692
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1693
a_callable=None, *args, **kwargs):
1694
"""Call callable with redirected std io pipes.
1696
Returns the return code."""
1697
if not callable(a_callable):
1698
raise ValueError("a_callable must be callable.")
1700
stdin = StringIO("")
1702
if getattr(self, "_log_file", None) is not None:
1703
stdout = self._log_file
1707
if getattr(self, "_log_file", None is not None):
1708
stderr = self._log_file
1711
real_stdin = sys.stdin
1712
real_stdout = sys.stdout
1713
real_stderr = sys.stderr
1718
return a_callable(*args, **kwargs)
1720
sys.stdout = real_stdout
1721
sys.stderr = real_stderr
1722
sys.stdin = real_stdin
1724
def reduceLockdirTimeout(self):
1725
"""Reduce the default lock timeout for the duration of the test, so that
1726
if LockContention occurs during a test, it does so quickly.
1728
Tests that expect to provoke LockContention errors should call this.
1730
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1732
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1733
self.addCleanup(resetTimeout)
1734
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1736
def make_utf8_encoded_stringio(self, encoding_type=None):
1737
"""Return a StringIOWrapper instance, that will encode Unicode
1740
if encoding_type is None:
1741
encoding_type = 'strict'
1743
output_encoding = 'utf-8'
1744
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1745
sio.encoding = output_encoding
1749
class TestCaseWithMemoryTransport(TestCase):
1750
"""Common test class for tests that do not need disk resources.
1752
Tests that need disk resources should derive from TestCaseWithTransport.
1754
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1756
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1757
a directory which does not exist. This serves to help ensure test isolation
1758
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1759
must exist. However, TestCaseWithMemoryTransport does not offer local
1760
file defaults for the transport in tests, nor does it obey the command line
1761
override, so tests that accidentally write to the common directory should
1764
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1765
a .bzr directory that stops us ascending higher into the filesystem.
1771
def __init__(self, methodName='runTest'):
1772
# allow test parameterization after test construction and before test
1773
# execution. Variables that the parameterizer sets need to be
1774
# ones that are not set by setUp, or setUp will trash them.
1775
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1776
self.vfs_transport_factory = default_transport
1777
self.transport_server = None
1778
self.transport_readonly_server = None
1779
self.__vfs_server = None
1781
def get_transport(self, relpath=None):
1782
"""Return a writeable transport.
1784
This transport is for the test scratch space relative to
1787
:param relpath: a path relative to the base url.
1789
t = get_transport(self.get_url(relpath))
1790
self.assertFalse(t.is_readonly())
1793
def get_readonly_transport(self, relpath=None):
1794
"""Return a readonly transport for the test scratch space
1796
This can be used to test that operations which should only need
1797
readonly access in fact do not try to write.
1799
:param relpath: a path relative to the base url.
1801
t = get_transport(self.get_readonly_url(relpath))
1802
self.assertTrue(t.is_readonly())
1805
def create_transport_readonly_server(self):
1806
"""Create a transport server from class defined at init.
1808
This is mostly a hook for daughter classes.
1810
return self.transport_readonly_server()
1812
def get_readonly_server(self):
1813
"""Get the server instance for the readonly transport
1815
This is useful for some tests with specific servers to do diagnostics.
1817
if self.__readonly_server is None:
1818
if self.transport_readonly_server is None:
1819
# readonly decorator requested
1820
# bring up the server
1821
self.__readonly_server = ReadonlyServer()
1822
self.__readonly_server.setUp(self.get_vfs_only_server())
1824
self.__readonly_server = self.create_transport_readonly_server()
1825
self.__readonly_server.setUp(self.get_vfs_only_server())
1826
self.addCleanup(self.__readonly_server.tearDown)
1827
return self.__readonly_server
1829
def get_readonly_url(self, relpath=None):
1830
"""Get a URL for the readonly transport.
1832
This will either be backed by '.' or a decorator to the transport
1833
used by self.get_url()
1834
relpath provides for clients to get a path relative to the base url.
1835
These should only be downwards relative, not upwards.
1837
base = self.get_readonly_server().get_url()
1838
return self._adjust_url(base, relpath)
1840
def get_vfs_only_server(self):
1841
"""Get the vfs only read/write server instance.
1843
This is useful for some tests with specific servers that need
1846
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1847
is no means to override it.
1849
if self.__vfs_server is None:
1850
self.__vfs_server = MemoryServer()
1851
self.__vfs_server.setUp()
1852
self.addCleanup(self.__vfs_server.tearDown)
1853
return self.__vfs_server
1855
def get_server(self):
1856
"""Get the read/write server instance.
1858
This is useful for some tests with specific servers that need
1861
This is built from the self.transport_server factory. If that is None,
1862
then the self.get_vfs_server is returned.
1864
if self.__server is None:
1865
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1866
return self.get_vfs_only_server()
1868
# bring up a decorated means of access to the vfs only server.
1869
self.__server = self.transport_server()
1871
self.__server.setUp(self.get_vfs_only_server())
1872
except TypeError, e:
1873
# This should never happen; the try:Except here is to assist
1874
# developers having to update code rather than seeing an
1875
# uninformative TypeError.
1876
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1877
self.addCleanup(self.__server.tearDown)
1878
return self.__server
1880
def _adjust_url(self, base, relpath):
1881
"""Get a URL (or maybe a path) for the readwrite transport.
1883
This will either be backed by '.' or to an equivalent non-file based
1885
relpath provides for clients to get a path relative to the base url.
1886
These should only be downwards relative, not upwards.
1888
if relpath is not None and relpath != '.':
1889
if not base.endswith('/'):
1891
# XXX: Really base should be a url; we did after all call
1892
# get_url()! But sometimes it's just a path (from
1893
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1894
# to a non-escaped local path.
1895
if base.startswith('./') or base.startswith('/'):
1898
base += urlutils.escape(relpath)
1901
def get_url(self, relpath=None):
1902
"""Get a URL (or maybe a path) for the readwrite transport.
1904
This will either be backed by '.' or to an equivalent non-file based
1906
relpath provides for clients to get a path relative to the base url.
1907
These should only be downwards relative, not upwards.
1909
base = self.get_server().get_url()
1910
return self._adjust_url(base, relpath)
1912
def get_vfs_only_url(self, relpath=None):
1913
"""Get a URL (or maybe a path for the plain old vfs transport.
1915
This will never be a smart protocol. It always has all the
1916
capabilities of the local filesystem, but it might actually be a
1917
MemoryTransport or some other similar virtual filesystem.
1919
This is the backing transport (if any) of the server returned by
1920
get_url and get_readonly_url.
1922
:param relpath: provides for clients to get a path relative to the base
1923
url. These should only be downwards relative, not upwards.
1926
base = self.get_vfs_only_server().get_url()
1927
return self._adjust_url(base, relpath)
1929
def _create_safety_net(self):
1930
"""Make a fake bzr directory.
1932
This prevents any tests propagating up onto the TEST_ROOT directory's
1935
root = TestCaseWithMemoryTransport.TEST_ROOT
1936
bzrdir.BzrDir.create_standalone_workingtree(root)
1938
def _check_safety_net(self):
1939
"""Check that the safety .bzr directory have not been touched.
1941
_make_test_root have created a .bzr directory to prevent tests from
1942
propagating. This method ensures than a test did not leaked.
1944
root = TestCaseWithMemoryTransport.TEST_ROOT
1945
wt = workingtree.WorkingTree.open(root)
1946
last_rev = wt.last_revision()
1947
if last_rev != 'null:':
1948
# The current test have modified the /bzr directory, we need to
1949
# recreate a new one or all the followng tests will fail.
1950
# If you need to inspect its content uncomment the following line
1951
# import pdb; pdb.set_trace()
1952
_rmtree_temp_dir(root + '/.bzr')
1953
self._create_safety_net()
1954
raise AssertionError('%s/.bzr should not be modified' % root)
1956
def _make_test_root(self):
1957
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1958
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1959
TestCaseWithMemoryTransport.TEST_ROOT = root
1961
self._create_safety_net()
1963
# The same directory is used by all tests, and we're not
1964
# specifically told when all tests are finished. This will do.
1965
atexit.register(_rmtree_temp_dir, root)
1967
self.addCleanup(self._check_safety_net)
1969
def makeAndChdirToTestDir(self):
1970
"""Create a temporary directories for this one test.
1972
This must set self.test_home_dir and self.test_dir and chdir to
1975
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1977
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1978
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1979
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1981
def make_branch(self, relpath, format=None):
1982
"""Create a branch on the transport at relpath."""
1983
repo = self.make_repository(relpath, format=format)
1984
return repo.bzrdir.create_branch()
1986
def make_bzrdir(self, relpath, format=None):
1988
# might be a relative or absolute path
1989
maybe_a_url = self.get_url(relpath)
1990
segments = maybe_a_url.rsplit('/', 1)
1991
t = get_transport(maybe_a_url)
1992
if len(segments) > 1 and segments[-1] not in ('', '.'):
1996
if isinstance(format, basestring):
1997
format = bzrdir.format_registry.make_bzrdir(format)
1998
return format.initialize_on_transport(t)
1999
except errors.UninitializableFormat:
2000
raise TestSkipped("Format %s is not initializable." % format)
2002
def make_repository(self, relpath, shared=False, format=None):
2003
"""Create a repository on our default transport at relpath.
2005
Note that relpath must be a relative path, not a full url.
2007
# FIXME: If you create a remoterepository this returns the underlying
2008
# real format, which is incorrect. Actually we should make sure that
2009
# RemoteBzrDir returns a RemoteRepository.
2010
# maybe mbp 20070410
2011
made_control = self.make_bzrdir(relpath, format=format)
2012
return made_control.create_repository(shared=shared)
2014
def make_branch_and_memory_tree(self, relpath, format=None):
2015
"""Create a branch on the default transport and a MemoryTree for it."""
2016
b = self.make_branch(relpath, format=format)
2017
return memorytree.MemoryTree.create_on_branch(b)
2019
def make_branch_builder(self, relpath, format=None):
2020
url = self.get_url(relpath)
2021
tran = get_transport(url)
2022
return branchbuilder.BranchBuilder(get_transport(url), format=format)
2024
def overrideEnvironmentForTesting(self):
2025
os.environ['HOME'] = self.test_home_dir
2026
os.environ['BZR_HOME'] = self.test_home_dir
2029
super(TestCaseWithMemoryTransport, self).setUp()
2030
self._make_test_root()
2031
_currentdir = os.getcwdu()
2032
def _leaveDirectory():
2033
os.chdir(_currentdir)
2034
self.addCleanup(_leaveDirectory)
2035
self.makeAndChdirToTestDir()
2036
self.overrideEnvironmentForTesting()
2037
self.__readonly_server = None
2038
self.__server = None
2039
self.reduceLockdirTimeout()
2042
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2043
"""Derived class that runs a test within a temporary directory.
2045
This is useful for tests that need to create a branch, etc.
2047
The directory is created in a slightly complex way: for each
2048
Python invocation, a new temporary top-level directory is created.
2049
All test cases create their own directory within that. If the
2050
tests complete successfully, the directory is removed.
2052
:ivar test_base_dir: The path of the top-level directory for this
2053
test, which contains a home directory and a work directory.
2055
:ivar test_home_dir: An initially empty directory under test_base_dir
2056
which is used as $HOME for this test.
2058
:ivar test_dir: A directory under test_base_dir used as the current
2059
directory when the test proper is run.
2062
OVERRIDE_PYTHON = 'python'
2064
def check_file_contents(self, filename, expect):
2065
self.log("check contents of file %s" % filename)
2066
contents = file(filename, 'r').read()
2067
if contents != expect:
2068
self.log("expected: %r" % expect)
2069
self.log("actually: %r" % contents)
2070
self.fail("contents of %s not as expected" % filename)
2072
def _getTestDirPrefix(self):
2073
# create a directory within the top level test directory
2074
if sys.platform == 'win32':
2075
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2076
# windows is likely to have path-length limits so use a short name
2077
name_prefix = name_prefix[-30:]
2079
name_prefix = re.sub('[/]', '_', self.id())
2082
def makeAndChdirToTestDir(self):
2083
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2085
For TestCaseInTempDir we create a temporary directory based on the test
2086
name and then create two subdirs - test and home under it.
2088
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2090
for i in range(100):
2091
if os.path.exists(name):
2092
name = name_prefix + '_' + str(i)
2096
# now create test and home directories within this dir
2097
self.test_base_dir = name
2098
self.test_home_dir = self.test_base_dir + '/home'
2099
os.mkdir(self.test_home_dir)
2100
self.test_dir = self.test_base_dir + '/work'
2101
os.mkdir(self.test_dir)
2102
os.chdir(self.test_dir)
2103
# put name of test inside
2104
f = file(self.test_base_dir + '/name', 'w')
2109
self.addCleanup(self.deleteTestDir)
2111
def deleteTestDir(self):
2112
os.chdir(self.TEST_ROOT)
2113
_rmtree_temp_dir(self.test_base_dir)
2115
def build_tree(self, shape, line_endings='binary', transport=None):
2116
"""Build a test tree according to a pattern.
2118
shape is a sequence of file specifications. If the final
2119
character is '/', a directory is created.
2121
This assumes that all the elements in the tree being built are new.
2123
This doesn't add anything to a branch.
2125
:type shape: list or tuple.
2126
:param line_endings: Either 'binary' or 'native'
2127
in binary mode, exact contents are written in native mode, the
2128
line endings match the default platform endings.
2129
:param transport: A transport to write to, for building trees on VFS's.
2130
If the transport is readonly or None, "." is opened automatically.
2133
if type(shape) not in (list, tuple):
2134
raise AssertionError("Parameter 'shape' should be "
2135
"a list or a tuple. Got %r instead" % (shape,))
2136
# It's OK to just create them using forward slashes on windows.
2137
if transport is None or transport.is_readonly():
2138
transport = get_transport(".")
2140
self.assert_(isinstance(name, basestring))
2142
transport.mkdir(urlutils.escape(name[:-1]))
2144
if line_endings == 'binary':
2146
elif line_endings == 'native':
2149
raise errors.BzrError(
2150
'Invalid line ending request %r' % line_endings)
2151
content = "contents of %s%s" % (name.encode('utf-8'), end)
2152
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2154
def build_tree_contents(self, shape):
2155
build_tree_contents(shape)
2157
def assertInWorkingTree(self, path, root_path='.', tree=None):
2158
"""Assert whether path or paths are in the WorkingTree"""
2160
tree = workingtree.WorkingTree.open(root_path)
2161
if not isinstance(path, basestring):
2163
self.assertInWorkingTree(p, tree=tree)
2165
self.assertIsNot(tree.path2id(path), None,
2166
path+' not in working tree.')
2168
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2169
"""Assert whether path or paths are not in the WorkingTree"""
2171
tree = workingtree.WorkingTree.open(root_path)
2172
if not isinstance(path, basestring):
2174
self.assertNotInWorkingTree(p,tree=tree)
2176
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2179
class TestCaseWithTransport(TestCaseInTempDir):
2180
"""A test case that provides get_url and get_readonly_url facilities.
2182
These back onto two transport servers, one for readonly access and one for
2185
If no explicit class is provided for readonly access, a
2186
ReadonlyTransportDecorator is used instead which allows the use of non disk
2187
based read write transports.
2189
If an explicit class is provided for readonly access, that server and the
2190
readwrite one must both define get_url() as resolving to os.getcwd().
2193
def get_vfs_only_server(self):
2194
"""See TestCaseWithMemoryTransport.
2196
This is useful for some tests with specific servers that need
2199
if self.__vfs_server is None:
2200
self.__vfs_server = self.vfs_transport_factory()
2201
self.__vfs_server.setUp()
2202
self.addCleanup(self.__vfs_server.tearDown)
2203
return self.__vfs_server
2205
def make_branch_and_tree(self, relpath, format=None):
2206
"""Create a branch on the transport and a tree locally.
2208
If the transport is not a LocalTransport, the Tree can't be created on
2209
the transport. In that case if the vfs_transport_factory is
2210
LocalURLServer the working tree is created in the local
2211
directory backing the transport, and the returned tree's branch and
2212
repository will also be accessed locally. Otherwise a lightweight
2213
checkout is created and returned.
2215
:param format: The BzrDirFormat.
2216
:returns: the WorkingTree.
2218
# TODO: always use the local disk path for the working tree,
2219
# this obviously requires a format that supports branch references
2220
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2222
b = self.make_branch(relpath, format=format)
2224
return b.bzrdir.create_workingtree()
2225
except errors.NotLocalUrl:
2226
# We can only make working trees locally at the moment. If the
2227
# transport can't support them, then we keep the non-disk-backed
2228
# branch and create a local checkout.
2229
if self.vfs_transport_factory is LocalURLServer:
2230
# the branch is colocated on disk, we cannot create a checkout.
2231
# hopefully callers will expect this.
2232
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2233
wt = local_controldir.create_workingtree()
2234
if wt.branch._format != b._format:
2236
# Make sure that assigning to wt._branch fixes wt.branch,
2237
# in case the implementation details of workingtree objects
2239
self.assertIs(b, wt.branch)
2242
return b.create_checkout(relpath, lightweight=True)
2244
def assertIsDirectory(self, relpath, transport):
2245
"""Assert that relpath within transport is a directory.
2247
This may not be possible on all transports; in that case it propagates
2248
a TransportNotPossible.
2251
mode = transport.stat(relpath).st_mode
2252
except errors.NoSuchFile:
2253
self.fail("path %s is not a directory; no such file"
2255
if not stat.S_ISDIR(mode):
2256
self.fail("path %s is not a directory; has mode %#o"
2259
def assertTreesEqual(self, left, right):
2260
"""Check that left and right have the same content and properties."""
2261
# we use a tree delta to check for equality of the content, and we
2262
# manually check for equality of other things such as the parents list.
2263
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2264
differences = left.changes_from(right)
2265
self.assertFalse(differences.has_changed(),
2266
"Trees %r and %r are different: %r" % (left, right, differences))
2269
super(TestCaseWithTransport, self).setUp()
2270
self.__vfs_server = None
2273
class ChrootedTestCase(TestCaseWithTransport):
2274
"""A support class that provides readonly urls outside the local namespace.
2276
This is done by checking if self.transport_server is a MemoryServer. if it
2277
is then we are chrooted already, if it is not then an HttpServer is used
2280
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2281
be used without needed to redo it when a different
2282
subclass is in use ?
2286
super(ChrootedTestCase, self).setUp()
2287
if not self.vfs_transport_factory == MemoryServer:
2288
self.transport_readonly_server = HttpServer
2291
def condition_id_re(pattern):
2292
"""Create a condition filter which performs a re check on a test's id.
2294
:param pattern: A regular expression string.
2295
:return: A callable that returns True if the re matches.
2297
filter_re = re.compile(pattern)
2298
def condition(test):
2300
return filter_re.search(test_id)
2304
def condition_isinstance(klass_or_klass_list):
2305
"""Create a condition filter which returns isinstance(param, klass).
2307
:return: A callable which when called with one parameter obj return the
2308
result of isinstance(obj, klass_or_klass_list).
2311
return isinstance(obj, klass_or_klass_list)
2315
def condition_id_in_list(id_list):
2316
"""Create a condition filter which verify that test's id in a list.
2318
:param id_list: A TestIdList object.
2319
:return: A callable that returns True if the test's id appears in the list.
2321
def condition(test):
2322
return id_list.includes(test.id())
2326
def condition_id_startswith(starts):
2327
"""Create a condition filter verifying that test's id starts with a string.
2329
:param starts: A list of string.
2330
:return: A callable that returns True if the test's id starts with one of
2333
def condition(test):
2334
for start in starts:
2335
if test.id().startswith(start):
2341
def exclude_tests_by_condition(suite, condition):
2342
"""Create a test suite which excludes some tests from suite.
2344
:param suite: The suite to get tests from.
2345
:param condition: A callable whose result evaluates True when called with a
2346
test case which should be excluded from the result.
2347
:return: A suite which contains the tests found in suite that fail
2351
for test in iter_suite_tests(suite):
2352
if not condition(test):
2354
return TestUtil.TestSuite(result)
2357
def filter_suite_by_condition(suite, condition):
2358
"""Create a test suite by filtering another one.
2360
:param suite: The source suite.
2361
:param condition: A callable whose result evaluates True when called with a
2362
test case which should be included in the result.
2363
:return: A suite which contains the tests found in suite that pass
2367
for test in iter_suite_tests(suite):
2370
return TestUtil.TestSuite(result)
2373
def filter_suite_by_re(suite, pattern):
2374
"""Create a test suite by filtering another one.
2376
:param suite: the source suite
2377
:param pattern: pattern that names must match
2378
:returns: the newly created suite
2380
condition = condition_id_re(pattern)
2381
result_suite = filter_suite_by_condition(suite, condition)
2385
def filter_suite_by_id_list(suite, test_id_list):
2386
"""Create a test suite by filtering another one.
2388
:param suite: The source suite.
2389
:param test_id_list: A list of the test ids to keep as strings.
2390
:returns: the newly created suite
2392
condition = condition_id_in_list(test_id_list)
2393
result_suite = filter_suite_by_condition(suite, condition)
2397
def filter_suite_by_id_startswith(suite, start):
2398
"""Create a test suite by filtering another one.
2400
:param suite: The source suite.
2401
:param start: A list of string the test id must start with one of.
2402
:returns: the newly created suite
2404
condition = condition_id_startswith(start)
2405
result_suite = filter_suite_by_condition(suite, condition)
2409
def exclude_tests_by_re(suite, pattern):
2410
"""Create a test suite which excludes some tests from suite.
2412
:param suite: The suite to get tests from.
2413
:param pattern: A regular expression string. Test ids that match this
2414
pattern will be excluded from the result.
2415
:return: A TestSuite that contains all the tests from suite without the
2416
tests that matched pattern. The order of tests is the same as it was in
2419
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2422
def preserve_input(something):
2423
"""A helper for performing test suite transformation chains.
2425
:param something: Anything you want to preserve.
2431
def randomize_suite(suite):
2432
"""Return a new TestSuite with suite's tests in random order.
2434
The tests in the input suite are flattened into a single suite in order to
2435
accomplish this. Any nested TestSuites are removed to provide global
2438
tests = list(iter_suite_tests(suite))
2439
random.shuffle(tests)
2440
return TestUtil.TestSuite(tests)
2443
def split_suite_by_condition(suite, condition):
2444
"""Split a test suite into two by a condition.
2446
:param suite: The suite to split.
2447
:param condition: The condition to match on. Tests that match this
2448
condition are returned in the first test suite, ones that do not match
2449
are in the second suite.
2450
:return: A tuple of two test suites, where the first contains tests from
2451
suite matching the condition, and the second contains the remainder
2452
from suite. The order within each output suite is the same as it was in
2457
for test in iter_suite_tests(suite):
2459
matched.append(test)
2461
did_not_match.append(test)
2462
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2465
def split_suite_by_re(suite, pattern):
2466
"""Split a test suite into two by a regular expression.
2468
:param suite: The suite to split.
2469
:param pattern: A regular expression string. Test ids that match this
2470
pattern will be in the first test suite returned, and the others in the
2471
second test suite returned.
2472
:return: A tuple of two test suites, where the first contains tests from
2473
suite matching pattern, and the second contains the remainder from
2474
suite. The order within each output suite is the same as it was in
2477
return split_suite_by_condition(suite, condition_id_re(pattern))
2480
def run_suite(suite, name='test', verbose=False, pattern=".*",
2481
stop_on_failure=False,
2482
transport=None, lsprof_timed=None, bench_history=None,
2483
matching_tests_first=None,
2486
exclude_pattern=None,
2488
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2493
runner = TextTestRunner(stream=sys.stdout,
2495
verbosity=verbosity,
2496
bench_history=bench_history,
2497
list_only=list_only,
2499
runner.stop_on_failure=stop_on_failure
2500
# Initialise the random number generator and display the seed used.
2501
# We convert the seed to a long to make it reuseable across invocations.
2502
random_order = False
2503
if random_seed is not None:
2505
if random_seed == "now":
2506
random_seed = long(time.time())
2508
# Convert the seed to a long if we can
2510
random_seed = long(random_seed)
2513
runner.stream.writeln("Randomizing test order using seed %s\n" %
2515
random.seed(random_seed)
2516
# Customise the list of tests if requested
2517
if exclude_pattern is not None:
2518
suite = exclude_tests_by_re(suite, exclude_pattern)
2520
order_changer = randomize_suite
2522
order_changer = preserve_input
2523
if pattern != '.*' or random_order:
2524
if matching_tests_first:
2525
suites = map(order_changer, split_suite_by_re(suite, pattern))
2526
suite = TestUtil.TestSuite(suites)
2528
suite = order_changer(filter_suite_by_re(suite, pattern))
2530
result = runner.run(suite)
2533
return result.wasStrictlySuccessful()
2535
return result.wasSuccessful()
2538
# Controlled by "bzr selftest -E=..." option
2539
selftest_debug_flags = set()
2542
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2544
test_suite_factory=None,
2547
matching_tests_first=None,
2550
exclude_pattern=None,
2556
"""Run the whole test suite under the enhanced runner"""
2557
# XXX: Very ugly way to do this...
2558
# Disable warning about old formats because we don't want it to disturb
2559
# any blackbox tests.
2560
from bzrlib import repository
2561
repository._deprecation_warning_done = True
2563
global default_transport
2564
if transport is None:
2565
transport = default_transport
2566
old_transport = default_transport
2567
default_transport = transport
2568
global selftest_debug_flags
2569
old_debug_flags = selftest_debug_flags
2570
if debug_flags is not None:
2571
selftest_debug_flags = set(debug_flags)
2573
if load_list is None:
2576
keep_only = load_test_id_list(load_list)
2577
if test_suite_factory is None:
2578
suite = test_suite(keep_only, starting_with)
2580
suite = test_suite_factory()
2581
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2582
stop_on_failure=stop_on_failure,
2583
transport=transport,
2584
lsprof_timed=lsprof_timed,
2585
bench_history=bench_history,
2586
matching_tests_first=matching_tests_first,
2587
list_only=list_only,
2588
random_seed=random_seed,
2589
exclude_pattern=exclude_pattern,
2592
default_transport = old_transport
2593
selftest_debug_flags = old_debug_flags
2596
def load_test_id_list(file_name):
2597
"""Load a test id list from a text file.
2599
The format is one test id by line. No special care is taken to impose
2600
strict rules, these test ids are used to filter the test suite so a test id
2601
that do not match an existing test will do no harm. This allows user to add
2602
comments, leave blank lines, etc.
2606
ftest = open(file_name, 'rt')
2608
if e.errno != errno.ENOENT:
2611
raise errors.NoSuchFile(file_name)
2613
for test_name in ftest.readlines():
2614
test_list.append(test_name.strip())
2619
def suite_matches_id_list(test_suite, id_list):
2620
"""Warns about tests not appearing or appearing more than once.
2622
:param test_suite: A TestSuite object.
2623
:param test_id_list: The list of test ids that should be found in
2626
:return: (absents, duplicates) absents is a list containing the test found
2627
in id_list but not in test_suite, duplicates is a list containing the
2628
test found multiple times in test_suite.
2630
When using a prefined test id list, it may occurs that some tests do not
2631
exist anymore or that some tests use the same id. This function warns the
2632
tester about potential problems in his workflow (test lists are volatile)
2633
or in the test suite itself (using the same id for several tests does not
2634
help to localize defects).
2636
# Build a dict counting id occurrences
2638
for test in iter_suite_tests(test_suite):
2640
tests[id] = tests.get(id, 0) + 1
2645
occurs = tests.get(id, 0)
2647
not_found.append(id)
2649
duplicates.append(id)
2651
return not_found, duplicates
2654
class TestIdList(object):
2655
"""Test id list to filter a test suite.
2657
Relying on the assumption that test ids are built as:
2658
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2659
notation, this class offers methods to :
2660
- avoid building a test suite for modules not refered to in the test list,
2661
- keep only the tests listed from the module test suite.
2664
def __init__(self, test_id_list):
2665
# When a test suite needs to be filtered against us we compare test ids
2666
# for equality, so a simple dict offers a quick and simple solution.
2667
self.tests = dict().fromkeys(test_id_list, True)
2669
# While unittest.TestCase have ids like:
2670
# <module>.<class>.<method>[(<param+)],
2671
# doctest.DocTestCase can have ids like:
2674
# <module>.<function>
2675
# <module>.<class>.<method>
2677
# Since we can't predict a test class from its name only, we settle on
2678
# a simple constraint: a test id always begins with its module name.
2681
for test_id in test_id_list:
2682
parts = test_id.split('.')
2683
mod_name = parts.pop(0)
2684
modules[mod_name] = True
2686
mod_name += '.' + part
2687
modules[mod_name] = True
2688
self.modules = modules
2690
def refers_to(self, module_name):
2691
"""Is there tests for the module or one of its sub modules."""
2692
return self.modules.has_key(module_name)
2694
def includes(self, test_id):
2695
return self.tests.has_key(test_id)
2698
class TestPrefixAliasRegistry(registry.Registry):
2699
"""A registry for test prefix aliases.
2701
This helps implement shorcuts for the --starting-with selftest
2702
option. Overriding existing prefixes is not allowed but not fatal (a
2703
warning will be emitted).
2706
def register(self, key, obj, help=None, info=None,
2707
override_existing=False):
2708
"""See Registry.register.
2710
Trying to override an existing alias causes a warning to be emitted,
2711
not a fatal execption.
2714
super(TestPrefixAliasRegistry, self).register(
2715
key, obj, help=help, info=info, override_existing=False)
2717
actual = self.get(key)
2718
note('Test prefix alias %s is already used for %s, ignoring %s'
2719
% (key, actual, obj))
2721
def resolve_alias(self, id_start):
2722
"""Replace the alias by the prefix in the given string.
2724
Using an unknown prefix is an error to help catching typos.
2726
parts = id_start.split('.')
2728
parts[0] = self.get(parts[0])
2730
raise errors.BzrCommandError(
2731
'%s is not a known test prefix alias' % parts[0])
2732
return '.'.join(parts)
2735
test_prefix_alias_registry = TestPrefixAliasRegistry()
2736
"""Registry of test prefix aliases."""
2739
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2740
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2741
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2743
# Obvious higest levels prefixes, feel free to add your own via a plugin
2744
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2745
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2746
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2747
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2748
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2751
def test_suite(keep_only=None, starting_with=None):
2752
"""Build and return TestSuite for the whole of bzrlib.
2754
:param keep_only: A list of test ids limiting the suite returned.
2756
:param starting_with: An id limiting the suite returned to the tests
2759
This function can be replaced if you need to change the default test
2760
suite on a global basis, but it is not encouraged.
2764
'bzrlib.tests.blackbox',
2765
'bzrlib.tests.branch_implementations',
2766
'bzrlib.tests.bzrdir_implementations',
2767
'bzrlib.tests.commands',
2768
'bzrlib.tests.interrepository_implementations',
2769
'bzrlib.tests.intertree_implementations',
2770
'bzrlib.tests.inventory_implementations',
2771
'bzrlib.tests.per_lock',
2772
'bzrlib.tests.per_repository',
2773
'bzrlib.tests.per_repository_reference',
2774
'bzrlib.tests.test__dirstate_helpers',
2775
'bzrlib.tests.test__walkdirs_win32',
2776
'bzrlib.tests.test_ancestry',
2777
'bzrlib.tests.test_annotate',
2778
'bzrlib.tests.test_api',
2779
'bzrlib.tests.test_atomicfile',
2780
'bzrlib.tests.test_bad_files',
2781
'bzrlib.tests.test_bisect_multi',
2782
'bzrlib.tests.test_branch',
2783
'bzrlib.tests.test_branchbuilder',
2784
'bzrlib.tests.test_btree_index',
2785
'bzrlib.tests.test_bugtracker',
2786
'bzrlib.tests.test_bundle',
2787
'bzrlib.tests.test_bzrdir',
2788
'bzrlib.tests.test_cache_utf8',
2789
'bzrlib.tests.test_chunk_writer',
2790
'bzrlib.tests.test_commands',
2791
'bzrlib.tests.test_commit',
2792
'bzrlib.tests.test_commit_merge',
2793
'bzrlib.tests.test_config',
2794
'bzrlib.tests.test_conflicts',
2795
'bzrlib.tests.test_counted_lock',
2796
'bzrlib.tests.test_decorators',
2797
'bzrlib.tests.test_delta',
2798
'bzrlib.tests.test_deprecated_graph',
2799
'bzrlib.tests.test_diff',
2800
'bzrlib.tests.test_directory_service',
2801
'bzrlib.tests.test_dirstate',
2802
'bzrlib.tests.test_email_message',
2803
'bzrlib.tests.test_errors',
2804
'bzrlib.tests.test_extract',
2805
'bzrlib.tests.test_fetch',
2806
'bzrlib.tests.test_ftp_transport',
2807
'bzrlib.tests.test_generate_docs',
2808
'bzrlib.tests.test_generate_ids',
2809
'bzrlib.tests.test_globbing',
2810
'bzrlib.tests.test_gpg',
2811
'bzrlib.tests.test_graph',
2812
'bzrlib.tests.test_hashcache',
2813
'bzrlib.tests.test_help',
2814
'bzrlib.tests.test_hooks',
2815
'bzrlib.tests.test_http',
2816
'bzrlib.tests.test_http_implementations',
2817
'bzrlib.tests.test_http_response',
2818
'bzrlib.tests.test_https_ca_bundle',
2819
'bzrlib.tests.test_identitymap',
2820
'bzrlib.tests.test_ignores',
2821
'bzrlib.tests.test_index',
2822
'bzrlib.tests.test_info',
2823
'bzrlib.tests.test_inv',
2824
'bzrlib.tests.test_knit',
2825
'bzrlib.tests.test_lazy_import',
2826
'bzrlib.tests.test_lazy_regex',
2827
'bzrlib.tests.test_lockable_files',
2828
'bzrlib.tests.test_lockdir',
2829
'bzrlib.tests.test_log',
2830
'bzrlib.tests.test_lru_cache',
2831
'bzrlib.tests.test_lsprof',
2832
'bzrlib.tests.test_mail_client',
2833
'bzrlib.tests.test_memorytree',
2834
'bzrlib.tests.test_merge',
2835
'bzrlib.tests.test_merge3',
2836
'bzrlib.tests.test_merge_core',
2837
'bzrlib.tests.test_merge_directive',
2838
'bzrlib.tests.test_missing',
2839
'bzrlib.tests.test_msgeditor',
2840
'bzrlib.tests.test_multiparent',
2841
'bzrlib.tests.test_mutabletree',
2842
'bzrlib.tests.test_nonascii',
2843
'bzrlib.tests.test_options',
2844
'bzrlib.tests.test_osutils',
2845
'bzrlib.tests.test_osutils_encodings',
2846
'bzrlib.tests.test_pack',
2847
'bzrlib.tests.test_pack_repository',
2848
'bzrlib.tests.test_patch',
2849
'bzrlib.tests.test_patches',
2850
'bzrlib.tests.test_permissions',
2851
'bzrlib.tests.test_plugins',
2852
'bzrlib.tests.test_progress',
2853
'bzrlib.tests.test_read_bundle',
2854
'bzrlib.tests.test_reconcile',
2855
'bzrlib.tests.test_reconfigure',
2856
'bzrlib.tests.test_registry',
2857
'bzrlib.tests.test_remote',
2858
'bzrlib.tests.test_repository',
2859
'bzrlib.tests.test_revert',
2860
'bzrlib.tests.test_revision',
2861
'bzrlib.tests.test_revisionspec',
2862
'bzrlib.tests.test_revisiontree',
2863
'bzrlib.tests.test_rio',
2864
'bzrlib.tests.test_rules',
2865
'bzrlib.tests.test_sampler',
2866
'bzrlib.tests.test_selftest',
2867
'bzrlib.tests.test_setup',
2868
'bzrlib.tests.test_sftp_transport',
2869
'bzrlib.tests.test_smart',
2870
'bzrlib.tests.test_smart_add',
2871
'bzrlib.tests.test_smart_transport',
2872
'bzrlib.tests.test_smtp_connection',
2873
'bzrlib.tests.test_source',
2874
'bzrlib.tests.test_ssh_transport',
2875
'bzrlib.tests.test_status',
2876
'bzrlib.tests.test_store',
2877
'bzrlib.tests.test_strace',
2878
'bzrlib.tests.test_subsume',
2879
'bzrlib.tests.test_switch',
2880
'bzrlib.tests.test_symbol_versioning',
2881
'bzrlib.tests.test_tag',
2882
'bzrlib.tests.test_testament',
2883
'bzrlib.tests.test_textfile',
2884
'bzrlib.tests.test_textmerge',
2885
'bzrlib.tests.test_timestamp',
2886
'bzrlib.tests.test_trace',
2887
'bzrlib.tests.test_transactions',
2888
'bzrlib.tests.test_transform',
2889
'bzrlib.tests.test_transport',
2890
'bzrlib.tests.test_transport_implementations',
2891
'bzrlib.tests.test_transport_log',
2892
'bzrlib.tests.test_tree',
2893
'bzrlib.tests.test_treebuilder',
2894
'bzrlib.tests.test_tsort',
2895
'bzrlib.tests.test_tuned_gzip',
2896
'bzrlib.tests.test_ui',
2897
'bzrlib.tests.test_uncommit',
2898
'bzrlib.tests.test_upgrade',
2899
'bzrlib.tests.test_upgrade_stacked',
2900
'bzrlib.tests.test_urlutils',
2901
'bzrlib.tests.test_version',
2902
'bzrlib.tests.test_version_info',
2903
'bzrlib.tests.test_versionedfile',
2904
'bzrlib.tests.test_weave',
2905
'bzrlib.tests.test_whitebox',
2906
'bzrlib.tests.test_win32utils',
2907
'bzrlib.tests.test_workingtree',
2908
'bzrlib.tests.test_workingtree_4',
2909
'bzrlib.tests.test_wsgi',
2910
'bzrlib.tests.test_xml',
2911
'bzrlib.tests.tree_implementations',
2912
'bzrlib.tests.workingtree_implementations',
2913
'bzrlib.util.tests.test_bencode',
22
MODULES_TO_DOCTEST = []
25
class BzrTestBase(InTempDir):
26
"""bzr-specific test base class"""
27
def run_bzr(self, *args, **kwargs):
28
retcode = kwargs.get('retcode', 0)
29
self.assertEquals(bzrlib.commands.run_bzr(args), retcode)
32
def selftest(verbose=False):
33
from unittest import TestLoader, TestSuite
34
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
35
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
36
from doctest import DocTestSuite
43
global MODULES_TO_TEST, MODULES_TO_DOCTEST
46
['bzrlib.selftest.whitebox',
47
'bzrlib.selftest.versioning',
48
'bzrlib.selftest.testinv',
49
'bzrlib.selftest.testmerge3',
50
'bzrlib.selftest.testhashcache',
51
'bzrlib.selftest.teststatus',
52
'bzrlib.selftest.testlog',
53
'bzrlib.selftest.blackbox',
54
'bzrlib.selftest.testrevisionnamespaces',
55
'bzrlib.selftest.testbranch',
56
'bzrlib.selftest.testrevision',
58
'bzrlib.selftest.testdiff',
2916
loader = TestUtil.TestLoader()
2919
starting_with = [test_prefix_alias_registry.resolve_alias(start)
2920
for start in starting_with]
2921
# We take precedence over keep_only because *at loading time* using
2922
# both options means we will load less tests for the same final result.
2923
def interesting_module(name):
2924
for start in starting_with:
2926
# Either the module name starts with the specified string
2927
name.startswith(start)
2928
# or it may contain tests starting with the specified string
2929
or start.startswith(name)
2933
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
2935
elif keep_only is not None:
2936
id_filter = TestIdList(keep_only)
2937
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2938
def interesting_module(name):
2939
return id_filter.refers_to(name)
2942
loader = TestUtil.TestLoader()
2943
def interesting_module(name):
2944
# No filtering, all modules are interesting
2947
suite = loader.suiteClass()
2949
# modules building their suite with loadTestsFromModuleNames
2950
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2952
modules_to_doctest = [
2957
'bzrlib.iterablefile',
2962
'bzrlib.symbol_versioning',
2965
'bzrlib.version_info_formats.format_custom',
2968
for mod in modules_to_doctest:
2969
if not interesting_module(mod):
2970
# No tests to keep here, move along
2973
doc_suite = doctest.DocTestSuite(mod)
2974
except ValueError, e:
2975
print '**failed to get doctest for: %s\n%s' % (mod, e)
2977
suite.addTest(doc_suite)
2979
default_encoding = sys.getdefaultencoding()
2980
for name, plugin in bzrlib.plugin.plugins().items():
2981
if not interesting_module(plugin.module.__name__):
2983
plugin_suite = plugin.test_suite()
2984
# We used to catch ImportError here and turn it into just a warning,
2985
# but really if you don't have --no-plugins this should be a failure.
2986
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2987
if plugin_suite is None:
2988
plugin_suite = plugin.load_plugin_tests(loader)
2989
if plugin_suite is not None:
2990
suite.addTest(plugin_suite)
2991
if default_encoding != sys.getdefaultencoding():
2992
bzrlib.trace.warning(
2993
'Plugin "%s" tried to reset default encoding to: %s', name,
2994
sys.getdefaultencoding())
2996
sys.setdefaultencoding(default_encoding)
2999
suite = filter_suite_by_id_startswith(suite, starting_with)
3001
if keep_only is not None:
3002
# Now that the referred modules have loaded their tests, keep only the
3004
suite = filter_suite_by_id_list(suite, id_filter)
3005
# Do some sanity checks on the id_list filtering
3006
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3008
# The tester has used both keep_only and starting_with, so he is
3009
# already aware that some tests are excluded from the list, there
3010
# is no need to tell him which.
3013
# Some tests mentioned in the list are not in the test suite. The
3014
# list may be out of date, report to the tester.
3015
for id in not_found:
3016
bzrlib.trace.warning('"%s" not found in the test suite', id)
3017
for id in duplicates:
3018
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3023
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
3024
"""Adapt all tests in some given modules to given scenarios.
3026
This is the recommended public interface for test parameterization.
3027
Typically the test_suite() method for a per-implementation test
3028
suite will call multiply_tests_from_modules and return the
3031
:param module_name_list: List of fully-qualified names of test
3033
:param scenario_iter: Iterable of pairs of (scenario_name,
3034
scenario_param_dict).
3035
:param loader: If provided, will be used instead of a new
3036
bzrlib.tests.TestLoader() instance.
3038
This returns a new TestSuite containing the cross product of
3039
all the tests in all the modules, each repeated for each scenario.
3040
Each test is adapted by adding the scenario name at the end
3041
of its name, and updating the test object's __dict__ with the
3042
scenario_param_dict.
3044
>>> r = multiply_tests_from_modules(
3045
... ['bzrlib.tests.test_sampler'],
3046
... [('one', dict(param=1)),
3047
... ('two', dict(param=2))])
3048
>>> tests = list(iter_suite_tests(r))
3052
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3058
# XXX: Isn't load_tests() a better way to provide the same functionality
3059
# without forcing a predefined TestScenarioApplier ? --vila 080215
3061
loader = TestUtil.TestLoader()
3063
suite = loader.suiteClass()
3065
adapter = TestScenarioApplier()
3066
adapter.scenarios = list(scenario_iter)
3067
adapt_modules(module_name_list, adapter, loader, suite)
3071
def multiply_scenarios(scenarios_left, scenarios_right):
3072
"""Multiply two sets of scenarios.
3074
:returns: the cartesian product of the two sets of scenarios, that is
3075
a scenario for every possible combination of a left scenario and a
3079
('%s,%s' % (left_name, right_name),
3080
dict(left_dict.items() + right_dict.items()))
3081
for left_name, left_dict in scenarios_left
3082
for right_name, right_dict in scenarios_right]
3086
def adapt_modules(mods_list, adapter, loader, suite):
3087
"""Adapt the modules in mods_list using adapter and add to suite."""
3088
tests = loader.loadTestsFromModuleNames(mods_list)
3089
adapt_tests(tests, adapter, suite)
3092
def adapt_tests(tests_list, adapter, suite):
3093
"""Adapt the tests in tests_list using adapter and add to suite."""
3094
for test in iter_suite_tests(tests_list):
3095
suite.addTests(adapter.adapt(test))
3098
def _rmtree_temp_dir(dirname):
3099
# If LANG=C we probably have created some bogus paths
3100
# which rmtree(unicode) will fail to delete
3101
# so make sure we are using rmtree(str) to delete everything
3102
# except on win32, where rmtree(str) will fail
3103
# since it doesn't have the property of byte-stream paths
3104
# (they are either ascii or mbcs)
3105
if sys.platform == 'win32':
3106
# make sure we are using the unicode win32 api
3107
dirname = unicode(dirname)
3109
dirname = dirname.encode(sys.getfilesystemencoding())
3111
osutils.rmtree(dirname)
3113
if sys.platform == 'win32' and e.errno == errno.EACCES:
3114
sys.stderr.write(('Permission denied: '
3115
'unable to remove testing dir '
3116
'%s\n' % os.path.basename(dirname)))
3121
class Feature(object):
3122
"""An operating system Feature."""
3125
self._available = None
3127
def available(self):
3128
"""Is the feature available?
3130
:return: True if the feature is available.
3132
if self._available is None:
3133
self._available = self._probe()
3134
return self._available
3137
"""Implement this method in concrete features.
3139
:return: True if the feature is available.
3141
raise NotImplementedError
3144
if getattr(self, 'feature_name', None):
3145
return self.feature_name()
3146
return self.__class__.__name__
3149
class _SymlinkFeature(Feature):
3152
return osutils.has_symlinks()
3154
def feature_name(self):
3157
SymlinkFeature = _SymlinkFeature()
3160
class _HardlinkFeature(Feature):
3163
return osutils.has_hardlinks()
3165
def feature_name(self):
3168
HardlinkFeature = _HardlinkFeature()
3171
class _OsFifoFeature(Feature):
3174
return getattr(os, 'mkfifo', None)
3176
def feature_name(self):
3177
return 'filesystem fifos'
3179
OsFifoFeature = _OsFifoFeature()
3182
class _UnicodeFilenameFeature(Feature):
3183
"""Does the filesystem support Unicode filenames?"""
3187
# Check for character combinations unlikely to be covered by any
3188
# single non-unicode encoding. We use the characters
3189
# - greek small letter alpha (U+03B1) and
3190
# - braille pattern dots-123456 (U+283F).
3191
os.stat(u'\u03b1\u283f')
3192
except UnicodeEncodeError:
3194
except (IOError, OSError):
3195
# The filesystem allows the Unicode filename but the file doesn't
3199
# The filesystem allows the Unicode filename and the file exists,
3203
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3206
class TestScenarioApplier(object):
3207
"""A tool to apply scenarios to tests."""
3209
def adapt(self, test):
3210
"""Return a TestSuite containing a copy of test for each scenario."""
3211
result = unittest.TestSuite()
3212
for scenario in self.scenarios:
3213
result.addTest(self.adapt_test_to_scenario(test, scenario))
3216
def adapt_test_to_scenario(self, test, scenario):
3217
"""Copy test and apply scenario to it.
3219
:param test: A test to adapt.
3220
:param scenario: A tuple describing the scenarion.
3221
The first element of the tuple is the new test id.
3222
The second element is a dict containing attributes to set on the
3224
:return: The adapted test.
3226
from copy import deepcopy
3227
new_test = deepcopy(test)
3228
for name, value in scenario[1].items():
3229
setattr(new_test, name, value)
3230
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3231
new_test.id = lambda: new_id
3235
def probe_unicode_in_user_encoding():
3236
"""Try to encode several unicode strings to use in unicode-aware tests.
3237
Return first successfull match.
3239
:return: (unicode value, encoded plain string value) or (None, None)
3241
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3242
for uni_val in possible_vals:
3244
str_val = uni_val.encode(osutils.get_user_encoding())
3245
except UnicodeEncodeError:
3246
# Try a different character
3249
return uni_val, str_val
3253
def probe_bad_non_ascii(encoding):
3254
"""Try to find [bad] character with code [128..255]
3255
that cannot be decoded to unicode in some encoding.
3256
Return None if all non-ascii characters is valid
3259
for i in xrange(128, 256):
3262
char.decode(encoding)
3263
except UnicodeDecodeError:
3268
class _FTPServerFeature(Feature):
3269
"""Some tests want an FTP Server, check if one is available.
3271
Right now, the only way this is available is if 'medusa' is installed.
3272
http://www.amk.ca/python/code/medusa.html
3277
import bzrlib.tests.ftp_server
3282
def feature_name(self):
3285
FTPServerFeature = _FTPServerFeature()
3288
class _UnicodeFilename(Feature):
3289
"""Does the filesystem support Unicode filenames?"""
3294
except UnicodeEncodeError:
3296
except (IOError, OSError):
3297
# The filesystem allows the Unicode filename but the file doesn't
3301
# The filesystem allows the Unicode filename and the file exists,
3305
UnicodeFilename = _UnicodeFilename()
3308
class _UTF8Filesystem(Feature):
3309
"""Is the filesystem UTF-8?"""
3312
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3316
UTF8Filesystem = _UTF8Filesystem()
3319
class _CaseInsensitiveFilesystemFeature(Feature):
3320
"""Check if underlying filesystem is case-insensitive
3321
(e.g. on Windows, Cygwin, MacOS)
3325
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3326
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3327
TestCaseWithMemoryTransport.TEST_ROOT = root
3329
root = TestCaseWithMemoryTransport.TEST_ROOT
3330
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3332
name_a = osutils.pathjoin(tdir, 'a')
3333
name_A = osutils.pathjoin(tdir, 'A')
3335
result = osutils.isdir(name_A)
3336
_rmtree_temp_dir(tdir)
3339
def feature_name(self):
3340
return 'case-insensitive filesystem'
3342
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
61
# XXX: should also test bzrlib.merge_core, but they seem to be out
62
# of date with the code.
64
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
65
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
66
if m not in MODULES_TO_DOCTEST:
67
MODULES_TO_DOCTEST.append(m)
70
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
71
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
77
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
79
for m in MODULES_TO_TEST:
80
suite.addTest(TestLoader().loadTestsFromModule(m))
82
for m in (MODULES_TO_DOCTEST):
83
suite.addTest(DocTestSuite(m))
85
for p in bzrlib.plugin.all_plugins:
86
if hasattr(p, 'test_suite'):
87
suite.addTest(p.test_suite())
89
import bzrlib.merge_core
90
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
92
return run_suite(suite, 'testbzr', verbose=verbose)
added
removed
bzrlib/selftest/__init__.py
