1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
65
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
if 'allow_debug' not in selftest_debug_flags:
797
self._preserved_debug_flags = set(debug.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.server
805
self._preserved_hooks = {
806
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
807
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
808
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
810
self.addCleanup(self._restoreHooks)
811
# reset all hooks to an empty instance of the appropriate type
812
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
813
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
815
def _silenceUI(self):
816
"""Turn off UI for duration of test"""
817
# by default the UI is off; tests can turn it on if they want it.
818
saved = ui.ui_factory
820
ui.ui_factory = saved
821
ui.ui_factory = ui.SilentUIFactory()
822
self.addCleanup(_restore)
824
def _ndiff_strings(self, a, b):
825
"""Return ndiff between two strings containing lines.
827
A trailing newline is added if missing to make the strings
829
if b and b[-1] != '\n':
831
if a and a[-1] != '\n':
833
difflines = difflib.ndiff(a.splitlines(True),
835
linejunk=lambda x: False,
836
charjunk=lambda x: False)
837
return ''.join(difflines)
839
def assertEqual(self, a, b, message=''):
843
except UnicodeError, e:
844
# If we can't compare without getting a UnicodeError, then
845
# obviously they are different
846
mutter('UnicodeError: %s', e)
849
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
851
pformat(a), pformat(b)))
853
assertEquals = assertEqual
855
def assertEqualDiff(self, a, b, message=None):
856
"""Assert two texts are equal, if not raise an exception.
858
This is intended for use with multi-line strings where it can
859
be hard to find the differences by eye.
861
# TODO: perhaps override assertEquals to call this for strings?
865
message = "texts not equal:\n"
867
message = 'first string is missing a final newline.\n'
869
message = 'second string is missing a final newline.\n'
870
raise AssertionError(message +
871
self._ndiff_strings(a, b))
873
def assertEqualMode(self, mode, mode_test):
874
self.assertEqual(mode, mode_test,
875
'mode mismatch %o != %o' % (mode, mode_test))
877
def assertEqualStat(self, expected, actual):
878
"""assert that expected and actual are the same stat result.
880
:param expected: A stat result.
881
:param actual: A stat result.
882
:raises AssertionError: If the expected and actual stat values differ
885
self.assertEqual(expected.st_size, actual.st_size)
886
self.assertEqual(expected.st_mtime, actual.st_mtime)
887
self.assertEqual(expected.st_ctime, actual.st_ctime)
888
self.assertEqual(expected.st_dev, actual.st_dev)
889
self.assertEqual(expected.st_ino, actual.st_ino)
890
self.assertEqual(expected.st_mode, actual.st_mode)
892
def assertPositive(self, val):
893
"""Assert that val is greater than 0."""
894
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
896
def assertNegative(self, val):
897
"""Assert that val is less than 0."""
898
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
900
def assertStartsWith(self, s, prefix):
901
if not s.startswith(prefix):
902
raise AssertionError('string %r does not start with %r' % (s, prefix))
904
def assertEndsWith(self, s, suffix):
905
"""Asserts that s ends with suffix."""
906
if not s.endswith(suffix):
907
raise AssertionError('string %r does not end with %r' % (s, suffix))
909
def assertContainsRe(self, haystack, needle_re):
910
"""Assert that a contains something matching a regular expression."""
911
if not re.search(needle_re, haystack):
912
if '\n' in haystack or len(haystack) > 60:
913
# a long string, format it in a more readable way
914
raise AssertionError(
915
'pattern "%s" not found in\n"""\\\n%s"""\n'
916
% (needle_re, haystack))
918
raise AssertionError('pattern "%s" not found in "%s"'
919
% (needle_re, haystack))
921
def assertNotContainsRe(self, haystack, needle_re):
922
"""Assert that a does not match a regular expression"""
923
if re.search(needle_re, haystack):
924
raise AssertionError('pattern "%s" found in "%s"'
925
% (needle_re, haystack))
927
def assertSubset(self, sublist, superlist):
928
"""Assert that every entry in sublist is present in superlist."""
929
missing = set(sublist) - set(superlist)
931
raise AssertionError("value(s) %r not present in container %r" %
932
(missing, superlist))
934
def assertListRaises(self, excClass, func, *args, **kwargs):
935
"""Fail unless excClass is raised when the iterator from func is used.
937
Many functions can return generators this makes sure
938
to wrap them in a list() call to make sure the whole generator
939
is run, and that the proper exception is raised.
942
list(func(*args, **kwargs))
946
if getattr(excClass,'__name__', None) is not None:
947
excName = excClass.__name__
949
excName = str(excClass)
950
raise self.failureException, "%s not raised" % excName
952
def assertRaises(self, excClass, callableObj, *args, **kwargs):
953
"""Assert that a callable raises a particular exception.
955
:param excClass: As for the except statement, this may be either an
956
exception class, or a tuple of classes.
957
:param callableObj: A callable, will be passed ``*args`` and
960
Returns the exception so that you can examine it.
963
callableObj(*args, **kwargs)
967
if getattr(excClass,'__name__', None) is not None:
968
excName = excClass.__name__
971
excName = str(excClass)
972
raise self.failureException, "%s not raised" % excName
974
def assertIs(self, left, right, message=None):
975
if not (left is right):
976
if message is not None:
977
raise AssertionError(message)
979
raise AssertionError("%r is not %r." % (left, right))
981
def assertIsNot(self, left, right, message=None):
983
if message is not None:
984
raise AssertionError(message)
986
raise AssertionError("%r is %r." % (left, right))
988
def assertTransportMode(self, transport, path, mode):
989
"""Fail if a path does not have mode mode.
991
If modes are not supported on this transport, the assertion is ignored.
993
if not transport._can_roundtrip_unix_modebits():
995
path_stat = transport.stat(path)
996
actual_mode = stat.S_IMODE(path_stat.st_mode)
997
self.assertEqual(mode, actual_mode,
998
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1000
def assertIsSameRealPath(self, path1, path2):
1001
"""Fail if path1 and path2 points to different files"""
1002
self.assertEqual(osutils.realpath(path1),
1003
osutils.realpath(path2),
1004
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1006
def assertIsInstance(self, obj, kls):
1007
"""Fail if obj is not an instance of kls"""
1008
if not isinstance(obj, kls):
1009
self.fail("%r is an instance of %s rather than %s" % (
1010
obj, obj.__class__, kls))
1012
def expectFailure(self, reason, assertion, *args, **kwargs):
1013
"""Invoke a test, expecting it to fail for the given reason.
1015
This is for assertions that ought to succeed, but currently fail.
1016
(The failure is *expected* but not *wanted*.) Please be very precise
1017
about the failure you're expecting. If a new bug is introduced,
1018
AssertionError should be raised, not KnownFailure.
1020
Frequently, expectFailure should be followed by an opposite assertion.
1023
Intended to be used with a callable that raises AssertionError as the
1024
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1026
Raises KnownFailure if the test fails. Raises AssertionError if the
1031
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1033
self.assertEqual(42, dynamic_val)
1035
This means that a dynamic_val of 54 will cause the test to raise
1036
a KnownFailure. Once math is fixed and the expectFailure is removed,
1037
only a dynamic_val of 42 will allow the test to pass. Anything other
1038
than 54 or 42 will cause an AssertionError.
1041
assertion(*args, **kwargs)
1042
except AssertionError:
1043
raise KnownFailure(reason)
1045
self.fail('Unexpected success. Should have failed: %s' % reason)
1047
def assertFileEqual(self, content, path):
1048
"""Fail if path does not contain 'content'."""
1049
self.failUnlessExists(path)
1050
f = file(path, 'rb')
1055
self.assertEqualDiff(content, s)
1057
def failUnlessExists(self, path):
1058
"""Fail unless path or paths, which may be abs or relative, exist."""
1059
if not isinstance(path, basestring):
1061
self.failUnlessExists(p)
1063
self.failUnless(osutils.lexists(path),path+" does not exist")
1065
def failIfExists(self, path):
1066
"""Fail if path or paths, which may be abs or relative, exist."""
1067
if not isinstance(path, basestring):
1069
self.failIfExists(p)
1071
self.failIf(osutils.lexists(path),path+" exists")
1073
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1074
"""A helper for callDeprecated and applyDeprecated.
1076
:param a_callable: A callable to call.
1077
:param args: The positional arguments for the callable
1078
:param kwargs: The keyword arguments for the callable
1079
:return: A tuple (warnings, result). result is the result of calling
1080
a_callable(``*args``, ``**kwargs``).
1083
def capture_warnings(msg, cls=None, stacklevel=None):
1084
# we've hooked into a deprecation specific callpath,
1085
# only deprecations should getting sent via it.
1086
self.assertEqual(cls, DeprecationWarning)
1087
local_warnings.append(msg)
1088
original_warning_method = symbol_versioning.warn
1089
symbol_versioning.set_warning_method(capture_warnings)
1091
result = a_callable(*args, **kwargs)
1093
symbol_versioning.set_warning_method(original_warning_method)
1094
return (local_warnings, result)
1096
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1097
"""Call a deprecated callable without warning the user.
1099
Note that this only captures warnings raised by symbol_versioning.warn,
1100
not other callers that go direct to the warning module.
1102
To test that a deprecated method raises an error, do something like
1105
self.assertRaises(errors.ReservedId,
1106
self.applyDeprecated,
1107
deprecated_in((1, 5, 0)),
1111
:param deprecation_format: The deprecation format that the callable
1112
should have been deprecated with. This is the same type as the
1113
parameter to deprecated_method/deprecated_function. If the
1114
callable is not deprecated with this format, an assertion error
1116
:param a_callable: A callable to call. This may be a bound method or
1117
a regular function. It will be called with ``*args`` and
1119
:param args: The positional arguments for the callable
1120
:param kwargs: The keyword arguments for the callable
1121
:return: The result of a_callable(``*args``, ``**kwargs``)
1123
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1125
expected_first_warning = symbol_versioning.deprecation_string(
1126
a_callable, deprecation_format)
1127
if len(call_warnings) == 0:
1128
self.fail("No deprecation warning generated by call to %s" %
1130
self.assertEqual(expected_first_warning, call_warnings[0])
1133
def callCatchWarnings(self, fn, *args, **kw):
1134
"""Call a callable that raises python warnings.
1136
The caller's responsible for examining the returned warnings.
1138
If the callable raises an exception, the exception is not
1139
caught and propagates up to the caller. In that case, the list
1140
of warnings is not available.
1142
:returns: ([warning_object, ...], fn_result)
1144
# XXX: This is not perfect, because it completely overrides the
1145
# warnings filters, and some code may depend on suppressing particular
1146
# warnings. It's the easiest way to insulate ourselves from -Werror,
1147
# though. -- Andrew, 20071062
1149
def _catcher(message, category, filename, lineno, file=None):
1150
# despite the name, 'message' is normally(?) a Warning subclass
1152
wlist.append(message)
1153
saved_showwarning = warnings.showwarning
1154
saved_filters = warnings.filters
1156
warnings.showwarning = _catcher
1157
warnings.filters = []
1158
result = fn(*args, **kw)
1160
warnings.showwarning = saved_showwarning
1161
warnings.filters = saved_filters
1162
return wlist, result
1164
def callDeprecated(self, expected, callable, *args, **kwargs):
1165
"""Assert that a callable is deprecated in a particular way.
1167
This is a very precise test for unusual requirements. The
1168
applyDeprecated helper function is probably more suited for most tests
1169
as it allows you to simply specify the deprecation format being used
1170
and will ensure that that is issued for the function being called.
1172
Note that this only captures warnings raised by symbol_versioning.warn,
1173
not other callers that go direct to the warning module. To catch
1174
general warnings, use callCatchWarnings.
1176
:param expected: a list of the deprecation warnings expected, in order
1177
:param callable: The callable to call
1178
:param args: The positional arguments for the callable
1179
:param kwargs: The keyword arguments for the callable
1181
call_warnings, result = self._capture_deprecation_warnings(callable,
1183
self.assertEqual(expected, call_warnings)
1186
def _startLogFile(self):
1187
"""Send bzr and test log messages to a temporary file.
1189
The file is removed as the test is torn down.
1191
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1192
self._log_file = os.fdopen(fileno, 'w+')
1193
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1194
self._log_file_name = name
1195
self.addCleanup(self._finishLogFile)
1197
def _finishLogFile(self):
1198
"""Finished with the log file.
1200
Close the file and delete it, unless setKeepLogfile was called.
1202
if self._log_file is None:
1204
bzrlib.trace.pop_log_file(self._log_memento)
1205
self._log_file.close()
1206
self._log_file = None
1207
if not self._keep_log_file:
1208
os.remove(self._log_file_name)
1209
self._log_file_name = None
1211
def setKeepLogfile(self):
1212
"""Make the logfile not be deleted when _finishLogFile is called."""
1213
self._keep_log_file = True
1215
def addCleanup(self, callable, *args, **kwargs):
1216
"""Arrange to run a callable when this case is torn down.
1218
Callables are run in the reverse of the order they are registered,
1219
ie last-in first-out.
1221
self._cleanups.append((callable, args, kwargs))
1223
def _cleanEnvironment(self):
1225
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1226
'HOME': os.getcwd(),
1227
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1228
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1230
'BZREMAIL': None, # may still be present in the environment
1232
'BZR_PROGRESS_BAR': None,
1235
'SSH_AUTH_SOCK': None,
1239
'https_proxy': None,
1240
'HTTPS_PROXY': None,
1245
# Nobody cares about these ones AFAIK. So far at
1246
# least. If you do (care), please update this comment
1250
'BZR_REMOTE_PATH': None,
1253
self.addCleanup(self._restoreEnvironment)
1254
for name, value in new_env.iteritems():
1255
self._captureVar(name, value)
1257
def _captureVar(self, name, newvalue):
1258
"""Set an environment variable, and reset it when finished."""
1259
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1261
def _restore_debug_flags(self):
1262
debug.debug_flags.clear()
1263
debug.debug_flags.update(self._preserved_debug_flags)
1265
def _restoreEnvironment(self):
1266
for name, value in self.__old_env.iteritems():
1267
osutils.set_or_unset_env(name, value)
1269
def _restoreHooks(self):
1270
for klass, hooks in self._preserved_hooks.items():
1271
setattr(klass, 'hooks', hooks)
1273
def knownFailure(self, reason):
1274
"""This test has failed for some known reason."""
1275
raise KnownFailure(reason)
1277
def run(self, result=None):
1278
if result is None: result = self.defaultTestResult()
1279
for feature in getattr(self, '_test_needs_features', []):
1280
if not feature.available():
1281
result.startTest(self)
1282
if getattr(result, 'addNotSupported', None):
1283
result.addNotSupported(self, feature)
1285
result.addSuccess(self)
1286
result.stopTest(self)
1289
return unittest.TestCase.run(self, result)
1292
absent_attr = object()
1293
for attr_name in self.attrs_to_keep:
1294
attr = getattr(self, attr_name, absent_attr)
1295
if attr is not absent_attr:
1296
saved_attrs[attr_name] = attr
1297
self.__dict__ = saved_attrs
1301
unittest.TestCase.tearDown(self)
1303
def time(self, callable, *args, **kwargs):
1304
"""Run callable and accrue the time it takes to the benchmark time.
1306
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1307
this will cause lsprofile statistics to be gathered and stored in
1310
if self._benchtime is None:
1314
if not self._gather_lsprof_in_benchmarks:
1315
return callable(*args, **kwargs)
1317
# record this benchmark
1318
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1320
self._benchcalls.append(((callable, args, kwargs), stats))
1323
self._benchtime += time.time() - start
1325
def _runCleanups(self):
1326
"""Run registered cleanup functions.
1328
This should only be called from TestCase.tearDown.
1330
# TODO: Perhaps this should keep running cleanups even if
1331
# one of them fails?
1333
# Actually pop the cleanups from the list so tearDown running
1334
# twice is safe (this happens for skipped tests).
1335
while self._cleanups:
1336
cleanup, args, kwargs = self._cleanups.pop()
1337
cleanup(*args, **kwargs)
1339
def log(self, *args):
1342
def _get_log(self, keep_log_file=False):
1343
"""Get the log from bzrlib.trace calls from this test.
1345
:param keep_log_file: When True, if the log is still a file on disk
1346
leave it as a file on disk. When False, if the log is still a file
1347
on disk, the log file is deleted and the log preserved as
1349
:return: A string containing the log.
1351
# flush the log file, to get all content
1353
bzrlib.trace._trace_file.flush()
1354
if self._log_contents:
1355
# XXX: this can hardly contain the content flushed above --vila
1357
return self._log_contents
1358
if self._log_file_name is not None:
1359
logfile = open(self._log_file_name)
1361
log_contents = logfile.read()
1364
if not keep_log_file:
1365
self._log_contents = log_contents
1367
os.remove(self._log_file_name)
1369
if sys.platform == 'win32' and e.errno == errno.EACCES:
1370
sys.stderr.write(('Unable to delete log file '
1371
' %r\n' % self._log_file_name))
1376
return "DELETED log file to reduce memory footprint"
1378
def requireFeature(self, feature):
1379
"""This test requires a specific feature is available.
1381
:raises UnavailableFeature: When feature is not available.
1383
if not feature.available():
1384
raise UnavailableFeature(feature)
1386
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1388
"""Run bazaar command line, splitting up a string command line."""
1389
if isinstance(args, basestring):
1390
# shlex don't understand unicode strings,
1391
# so args should be plain string (bialix 20070906)
1392
args = list(shlex.split(str(args)))
1393
return self._run_bzr_core(args, retcode=retcode,
1394
encoding=encoding, stdin=stdin, working_dir=working_dir,
1397
def _run_bzr_core(self, args, retcode, encoding, stdin,
1399
if encoding is None:
1400
encoding = bzrlib.user_encoding
1401
stdout = StringIOWrapper()
1402
stderr = StringIOWrapper()
1403
stdout.encoding = encoding
1404
stderr.encoding = encoding
1406
self.log('run bzr: %r', args)
1407
# FIXME: don't call into logging here
1408
handler = logging.StreamHandler(stderr)
1409
handler.setLevel(logging.INFO)
1410
logger = logging.getLogger('')
1411
logger.addHandler(handler)
1412
old_ui_factory = ui.ui_factory
1413
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1416
if working_dir is not None:
1417
cwd = osutils.getcwd()
1418
os.chdir(working_dir)
1421
result = self.apply_redirected(ui.ui_factory.stdin,
1423
bzrlib.commands.run_bzr_catch_user_errors,
1426
logger.removeHandler(handler)
1427
ui.ui_factory = old_ui_factory
1431
out = stdout.getvalue()
1432
err = stderr.getvalue()
1434
self.log('output:\n%r', out)
1436
self.log('errors:\n%r', err)
1437
if retcode is not None:
1438
self.assertEquals(retcode, result,
1439
message='Unexpected return code')
1442
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1443
working_dir=None, error_regexes=[], output_encoding=None):
1444
"""Invoke bzr, as if it were run from the command line.
1446
The argument list should not include the bzr program name - the
1447
first argument is normally the bzr command. Arguments may be
1448
passed in three ways:
1450
1- A list of strings, eg ["commit", "a"]. This is recommended
1451
when the command contains whitespace or metacharacters, or
1452
is built up at run time.
1454
2- A single string, eg "add a". This is the most convenient
1455
for hardcoded commands.
1457
This runs bzr through the interface that catches and reports
1458
errors, and with logging set to something approximating the
1459
default, so that error reporting can be checked.
1461
This should be the main method for tests that want to exercise the
1462
overall behavior of the bzr application (rather than a unit test
1463
or a functional test of the library.)
1465
This sends the stdout/stderr results into the test's log,
1466
where it may be useful for debugging. See also run_captured.
1468
:keyword stdin: A string to be used as stdin for the command.
1469
:keyword retcode: The status code the command should return;
1471
:keyword working_dir: The directory to run the command in
1472
:keyword error_regexes: A list of expected error messages. If
1473
specified they must be seen in the error output of the command.
1475
out, err = self._run_bzr_autosplit(
1480
working_dir=working_dir,
1482
for regex in error_regexes:
1483
self.assertContainsRe(err, regex)
1486
def run_bzr_error(self, error_regexes, *args, **kwargs):
1487
"""Run bzr, and check that stderr contains the supplied regexes
1489
:param error_regexes: Sequence of regular expressions which
1490
must each be found in the error output. The relative ordering
1492
:param args: command-line arguments for bzr
1493
:param kwargs: Keyword arguments which are interpreted by run_bzr
1494
This function changes the default value of retcode to be 3,
1495
since in most cases this is run when you expect bzr to fail.
1497
:return: (out, err) The actual output of running the command (in case
1498
you want to do more inspection)
1502
# Make sure that commit is failing because there is nothing to do
1503
self.run_bzr_error(['no changes to commit'],
1504
['commit', '-m', 'my commit comment'])
1505
# Make sure --strict is handling an unknown file, rather than
1506
# giving us the 'nothing to do' error
1507
self.build_tree(['unknown'])
1508
self.run_bzr_error(['Commit refused because there are unknown files'],
1509
['commit', --strict', '-m', 'my commit comment'])
1511
kwargs.setdefault('retcode', 3)
1512
kwargs['error_regexes'] = error_regexes
1513
out, err = self.run_bzr(*args, **kwargs)
1516
def run_bzr_subprocess(self, *args, **kwargs):
1517
"""Run bzr in a subprocess for testing.
1519
This starts a new Python interpreter and runs bzr in there.
1520
This should only be used for tests that have a justifiable need for
1521
this isolation: e.g. they are testing startup time, or signal
1522
handling, or early startup code, etc. Subprocess code can't be
1523
profiled or debugged so easily.
1525
:keyword retcode: The status code that is expected. Defaults to 0. If
1526
None is supplied, the status code is not checked.
1527
:keyword env_changes: A dictionary which lists changes to environment
1528
variables. A value of None will unset the env variable.
1529
The values must be strings. The change will only occur in the
1530
child, so you don't need to fix the environment after running.
1531
:keyword universal_newlines: Convert CRLF => LF
1532
:keyword allow_plugins: By default the subprocess is run with
1533
--no-plugins to ensure test reproducibility. Also, it is possible
1534
for system-wide plugins to create unexpected output on stderr,
1535
which can cause unnecessary test failures.
1537
env_changes = kwargs.get('env_changes', {})
1538
working_dir = kwargs.get('working_dir', None)
1539
allow_plugins = kwargs.get('allow_plugins', False)
1541
if isinstance(args[0], list):
1543
elif isinstance(args[0], basestring):
1544
args = list(shlex.split(args[0]))
1546
raise ValueError("passing varargs to run_bzr_subprocess")
1547
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1548
working_dir=working_dir,
1549
allow_plugins=allow_plugins)
1550
# We distinguish between retcode=None and retcode not passed.
1551
supplied_retcode = kwargs.get('retcode', 0)
1552
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1553
universal_newlines=kwargs.get('universal_newlines', False),
1556
def start_bzr_subprocess(self, process_args, env_changes=None,
1557
skip_if_plan_to_signal=False,
1559
allow_plugins=False):
1560
"""Start bzr in a subprocess for testing.
1562
This starts a new Python interpreter and runs bzr in there.
1563
This should only be used for tests that have a justifiable need for
1564
this isolation: e.g. they are testing startup time, or signal
1565
handling, or early startup code, etc. Subprocess code can't be
1566
profiled or debugged so easily.
1568
:param process_args: a list of arguments to pass to the bzr executable,
1569
for example ``['--version']``.
1570
:param env_changes: A dictionary which lists changes to environment
1571
variables. A value of None will unset the env variable.
1572
The values must be strings. The change will only occur in the
1573
child, so you don't need to fix the environment after running.
1574
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1576
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1578
:returns: Popen object for the started process.
1580
if skip_if_plan_to_signal:
1581
if not getattr(os, 'kill', None):
1582
raise TestSkipped("os.kill not available.")
1584
if env_changes is None:
1588
def cleanup_environment():
1589
for env_var, value in env_changes.iteritems():
1590
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1592
def restore_environment():
1593
for env_var, value in old_env.iteritems():
1594
osutils.set_or_unset_env(env_var, value)
1596
bzr_path = self.get_bzr_path()
1599
if working_dir is not None:
1600
cwd = osutils.getcwd()
1601
os.chdir(working_dir)
1604
# win32 subprocess doesn't support preexec_fn
1605
# so we will avoid using it on all platforms, just to
1606
# make sure the code path is used, and we don't break on win32
1607
cleanup_environment()
1608
command = [sys.executable]
1609
# frozen executables don't need the path to bzr
1610
if getattr(sys, "frozen", None) is None:
1611
command.append(bzr_path)
1612
if not allow_plugins:
1613
command.append('--no-plugins')
1614
command.extend(process_args)
1615
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1617
restore_environment()
1623
def _popen(self, *args, **kwargs):
1624
"""Place a call to Popen.
1626
Allows tests to override this method to intercept the calls made to
1627
Popen for introspection.
1629
return Popen(*args, **kwargs)
1631
def get_bzr_path(self):
1632
"""Return the path of the 'bzr' executable for this test suite."""
1633
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1634
if not os.path.isfile(bzr_path):
1635
# We are probably installed. Assume sys.argv is the right file
1636
bzr_path = sys.argv[0]
1639
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1640
universal_newlines=False, process_args=None):
1641
"""Finish the execution of process.
1643
:param process: the Popen object returned from start_bzr_subprocess.
1644
:param retcode: The status code that is expected. Defaults to 0. If
1645
None is supplied, the status code is not checked.
1646
:param send_signal: an optional signal to send to the process.
1647
:param universal_newlines: Convert CRLF => LF
1648
:returns: (stdout, stderr)
1650
if send_signal is not None:
1651
os.kill(process.pid, send_signal)
1652
out, err = process.communicate()
1654
if universal_newlines:
1655
out = out.replace('\r\n', '\n')
1656
err = err.replace('\r\n', '\n')
1658
if retcode is not None and retcode != process.returncode:
1659
if process_args is None:
1660
process_args = "(unknown args)"
1661
mutter('Output of bzr %s:\n%s', process_args, out)
1662
mutter('Error for bzr %s:\n%s', process_args, err)
1663
self.fail('Command bzr %s failed with retcode %s != %s'
1664
% (process_args, retcode, process.returncode))
1667
def check_inventory_shape(self, inv, shape):
1668
"""Compare an inventory to a list of expected names.
1670
Fail if they are not precisely equal.
1673
shape = list(shape) # copy
1674
for path, ie in inv.entries():
1675
name = path.replace('\\', '/')
1676
if ie.kind == 'directory':
1683
self.fail("expected paths not found in inventory: %r" % shape)
1685
self.fail("unexpected paths found in inventory: %r" % extras)
1687
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1688
a_callable=None, *args, **kwargs):
1689
"""Call callable with redirected std io pipes.
1691
Returns the return code."""
1692
if not callable(a_callable):
1693
raise ValueError("a_callable must be callable.")
1695
stdin = StringIO("")
1697
if getattr(self, "_log_file", None) is not None:
1698
stdout = self._log_file
1702
if getattr(self, "_log_file", None is not None):
1703
stderr = self._log_file
1706
real_stdin = sys.stdin
1707
real_stdout = sys.stdout
1708
real_stderr = sys.stderr
1713
return a_callable(*args, **kwargs)
1715
sys.stdout = real_stdout
1716
sys.stderr = real_stderr
1717
sys.stdin = real_stdin
1719
def reduceLockdirTimeout(self):
1720
"""Reduce the default lock timeout for the duration of the test, so that
1721
if LockContention occurs during a test, it does so quickly.
1723
Tests that expect to provoke LockContention errors should call this.
1725
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1727
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1728
self.addCleanup(resetTimeout)
1729
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1731
def make_utf8_encoded_stringio(self, encoding_type=None):
1732
"""Return a StringIOWrapper instance, that will encode Unicode
1735
if encoding_type is None:
1736
encoding_type = 'strict'
1738
output_encoding = 'utf-8'
1739
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1740
sio.encoding = output_encoding
1744
class TestCaseWithMemoryTransport(TestCase):
1745
"""Common test class for tests that do not need disk resources.
1747
Tests that need disk resources should derive from TestCaseWithTransport.
1749
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1751
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1752
a directory which does not exist. This serves to help ensure test isolation
1753
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1754
must exist. However, TestCaseWithMemoryTransport does not offer local
1755
file defaults for the transport in tests, nor does it obey the command line
1756
override, so tests that accidentally write to the common directory should
1759
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1760
a .bzr directory that stops us ascending higher into the filesystem.
1766
def __init__(self, methodName='runTest'):
1767
# allow test parameterization after test construction and before test
1768
# execution. Variables that the parameterizer sets need to be
1769
# ones that are not set by setUp, or setUp will trash them.
1770
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1771
self.vfs_transport_factory = default_transport
1772
self.transport_server = None
1773
self.transport_readonly_server = None
1774
self.__vfs_server = None
1776
def get_transport(self, relpath=None):
1777
"""Return a writeable transport.
1779
This transport is for the test scratch space relative to
1782
:param relpath: a path relative to the base url.
1784
t = get_transport(self.get_url(relpath))
1785
self.assertFalse(t.is_readonly())
1788
def get_readonly_transport(self, relpath=None):
1789
"""Return a readonly transport for the test scratch space
1791
This can be used to test that operations which should only need
1792
readonly access in fact do not try to write.
1794
:param relpath: a path relative to the base url.
1796
t = get_transport(self.get_readonly_url(relpath))
1797
self.assertTrue(t.is_readonly())
1800
def create_transport_readonly_server(self):
1801
"""Create a transport server from class defined at init.
1803
This is mostly a hook for daughter classes.
1805
return self.transport_readonly_server()
1807
def get_readonly_server(self):
1808
"""Get the server instance for the readonly transport
1810
This is useful for some tests with specific servers to do diagnostics.
1812
if self.__readonly_server is None:
1813
if self.transport_readonly_server is None:
1814
# readonly decorator requested
1815
# bring up the server
1816
self.__readonly_server = ReadonlyServer()
1817
self.__readonly_server.setUp(self.get_vfs_only_server())
1819
self.__readonly_server = self.create_transport_readonly_server()
1820
self.__readonly_server.setUp(self.get_vfs_only_server())
1821
self.addCleanup(self.__readonly_server.tearDown)
1822
return self.__readonly_server
1824
def get_readonly_url(self, relpath=None):
1825
"""Get a URL for the readonly transport.
1827
This will either be backed by '.' or a decorator to the transport
1828
used by self.get_url()
1829
relpath provides for clients to get a path relative to the base url.
1830
These should only be downwards relative, not upwards.
1832
base = self.get_readonly_server().get_url()
1833
return self._adjust_url(base, relpath)
1835
def get_vfs_only_server(self):
1836
"""Get the vfs only read/write server instance.
1838
This is useful for some tests with specific servers that need
1841
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1842
is no means to override it.
1844
if self.__vfs_server is None:
1845
self.__vfs_server = MemoryServer()
1846
self.__vfs_server.setUp()
1847
self.addCleanup(self.__vfs_server.tearDown)
1848
return self.__vfs_server
1850
def get_server(self):
1851
"""Get the read/write server instance.
1853
This is useful for some tests with specific servers that need
1856
This is built from the self.transport_server factory. If that is None,
1857
then the self.get_vfs_server is returned.
1859
if self.__server is None:
1860
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1861
return self.get_vfs_only_server()
1863
# bring up a decorated means of access to the vfs only server.
1864
self.__server = self.transport_server()
1866
self.__server.setUp(self.get_vfs_only_server())
1867
except TypeError, e:
1868
# This should never happen; the try:Except here is to assist
1869
# developers having to update code rather than seeing an
1870
# uninformative TypeError.
1871
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1872
self.addCleanup(self.__server.tearDown)
1873
return self.__server
1875
def _adjust_url(self, base, relpath):
1876
"""Get a URL (or maybe a path) for the readwrite transport.
1878
This will either be backed by '.' or to an equivalent non-file based
1880
relpath provides for clients to get a path relative to the base url.
1881
These should only be downwards relative, not upwards.
1883
if relpath is not None and relpath != '.':
1884
if not base.endswith('/'):
1886
# XXX: Really base should be a url; we did after all call
1887
# get_url()! But sometimes it's just a path (from
1888
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1889
# to a non-escaped local path.
1890
if base.startswith('./') or base.startswith('/'):
1893
base += urlutils.escape(relpath)
1896
def get_url(self, relpath=None):
1897
"""Get a URL (or maybe a path) for the readwrite transport.
1899
This will either be backed by '.' or to an equivalent non-file based
1901
relpath provides for clients to get a path relative to the base url.
1902
These should only be downwards relative, not upwards.
1904
base = self.get_server().get_url()
1905
return self._adjust_url(base, relpath)
1907
def get_vfs_only_url(self, relpath=None):
1908
"""Get a URL (or maybe a path for the plain old vfs transport.
1910
This will never be a smart protocol. It always has all the
1911
capabilities of the local filesystem, but it might actually be a
1912
MemoryTransport or some other similar virtual filesystem.
1914
This is the backing transport (if any) of the server returned by
1915
get_url and get_readonly_url.
1917
:param relpath: provides for clients to get a path relative to the base
1918
url. These should only be downwards relative, not upwards.
1921
base = self.get_vfs_only_server().get_url()
1922
return self._adjust_url(base, relpath)
1924
def _create_safety_net(self):
1925
"""Make a fake bzr directory.
1927
This prevents any tests propagating up onto the TEST_ROOT directory's
1930
root = TestCaseWithMemoryTransport.TEST_ROOT
1931
bzrdir.BzrDir.create_standalone_workingtree(root)
1933
def _check_safety_net(self):
1934
"""Check that the safety .bzr directory have not been touched.
1936
_make_test_root have created a .bzr directory to prevent tests from
1937
propagating. This method ensures than a test did not leaked.
1939
root = TestCaseWithMemoryTransport.TEST_ROOT
1940
wt = workingtree.WorkingTree.open(root)
1941
last_rev = wt.last_revision()
1942
if last_rev != 'null:':
1943
# The current test have modified the /bzr directory, we need to
1944
# recreate a new one or all the followng tests will fail.
1945
# If you need to inspect its content uncomment the following line
1946
# import pdb; pdb.set_trace()
1947
_rmtree_temp_dir(root + '/.bzr')
1948
self._create_safety_net()
1949
raise AssertionError('%s/.bzr should not be modified' % root)
1951
def _make_test_root(self):
1952
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1953
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1954
TestCaseWithMemoryTransport.TEST_ROOT = root
1956
self._create_safety_net()
1958
# The same directory is used by all tests, and we're not
1959
# specifically told when all tests are finished. This will do.
1960
atexit.register(_rmtree_temp_dir, root)
1962
self.addCleanup(self._check_safety_net)
1964
def makeAndChdirToTestDir(self):
1965
"""Create a temporary directories for this one test.
1967
This must set self.test_home_dir and self.test_dir and chdir to
1970
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1972
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1973
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1974
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1976
def make_branch(self, relpath, format=None):
1977
"""Create a branch on the transport at relpath."""
1978
repo = self.make_repository(relpath, format=format)
1979
return repo.bzrdir.create_branch()
1981
def make_bzrdir(self, relpath, format=None):
1983
# might be a relative or absolute path
1984
maybe_a_url = self.get_url(relpath)
1985
segments = maybe_a_url.rsplit('/', 1)
1986
t = get_transport(maybe_a_url)
1987
if len(segments) > 1 and segments[-1] not in ('', '.'):
1991
if isinstance(format, basestring):
1992
format = bzrdir.format_registry.make_bzrdir(format)
1993
return format.initialize_on_transport(t)
1994
except errors.UninitializableFormat:
1995
raise TestSkipped("Format %s is not initializable." % format)
1997
def make_repository(self, relpath, shared=False, format=None):
1998
"""Create a repository on our default transport at relpath.
2000
Note that relpath must be a relative path, not a full url.
2002
# FIXME: If you create a remoterepository this returns the underlying
2003
# real format, which is incorrect. Actually we should make sure that
2004
# RemoteBzrDir returns a RemoteRepository.
2005
# maybe mbp 20070410
2006
made_control = self.make_bzrdir(relpath, format=format)
2007
return made_control.create_repository(shared=shared)
2009
def make_branch_and_memory_tree(self, relpath, format=None):
2010
"""Create a branch on the default transport and a MemoryTree for it."""
2011
b = self.make_branch(relpath, format=format)
2012
return memorytree.MemoryTree.create_on_branch(b)
2014
def make_branch_builder(self, relpath, format=None):
2015
url = self.get_url(relpath)
2016
tran = get_transport(url)
2017
return branchbuilder.BranchBuilder(get_transport(url), format=format)
2019
def overrideEnvironmentForTesting(self):
2020
os.environ['HOME'] = self.test_home_dir
2021
os.environ['BZR_HOME'] = self.test_home_dir
2024
super(TestCaseWithMemoryTransport, self).setUp()
2025
self._make_test_root()
2026
_currentdir = os.getcwdu()
2027
def _leaveDirectory():
2028
os.chdir(_currentdir)
2029
self.addCleanup(_leaveDirectory)
2030
self.makeAndChdirToTestDir()
2031
self.overrideEnvironmentForTesting()
2032
self.__readonly_server = None
2033
self.__server = None
2034
self.reduceLockdirTimeout()
2037
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2038
"""Derived class that runs a test within a temporary directory.
2040
This is useful for tests that need to create a branch, etc.
2042
The directory is created in a slightly complex way: for each
2043
Python invocation, a new temporary top-level directory is created.
2044
All test cases create their own directory within that. If the
2045
tests complete successfully, the directory is removed.
2047
:ivar test_base_dir: The path of the top-level directory for this
2048
test, which contains a home directory and a work directory.
2050
:ivar test_home_dir: An initially empty directory under test_base_dir
2051
which is used as $HOME for this test.
2053
:ivar test_dir: A directory under test_base_dir used as the current
2054
directory when the test proper is run.
2057
OVERRIDE_PYTHON = 'python'
2059
def check_file_contents(self, filename, expect):
2060
self.log("check contents of file %s" % filename)
2061
contents = file(filename, 'r').read()
2062
if contents != expect:
2063
self.log("expected: %r" % expect)
2064
self.log("actually: %r" % contents)
2065
self.fail("contents of %s not as expected" % filename)
2067
def _getTestDirPrefix(self):
2068
# create a directory within the top level test directory
2069
if sys.platform == 'win32':
2070
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2071
# windows is likely to have path-length limits so use a short name
2072
name_prefix = name_prefix[-30:]
2074
name_prefix = re.sub('[/]', '_', self.id())
2077
def makeAndChdirToTestDir(self):
2078
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2080
For TestCaseInTempDir we create a temporary directory based on the test
2081
name and then create two subdirs - test and home under it.
2083
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2085
for i in range(100):
2086
if os.path.exists(name):
2087
name = name_prefix + '_' + str(i)
2091
# now create test and home directories within this dir
2092
self.test_base_dir = name
2093
self.test_home_dir = self.test_base_dir + '/home'
2094
os.mkdir(self.test_home_dir)
2095
self.test_dir = self.test_base_dir + '/work'
2096
os.mkdir(self.test_dir)
2097
os.chdir(self.test_dir)
2098
# put name of test inside
2099
f = file(self.test_base_dir + '/name', 'w')
2104
self.addCleanup(self.deleteTestDir)
2106
def deleteTestDir(self):
2107
os.chdir(self.TEST_ROOT)
2108
_rmtree_temp_dir(self.test_base_dir)
2110
def build_tree(self, shape, line_endings='binary', transport=None):
2111
"""Build a test tree according to a pattern.
2113
shape is a sequence of file specifications. If the final
2114
character is '/', a directory is created.
2116
This assumes that all the elements in the tree being built are new.
2118
This doesn't add anything to a branch.
2120
:type shape: list or tuple.
2121
:param line_endings: Either 'binary' or 'native'
2122
in binary mode, exact contents are written in native mode, the
2123
line endings match the default platform endings.
2124
:param transport: A transport to write to, for building trees on VFS's.
2125
If the transport is readonly or None, "." is opened automatically.
2128
if type(shape) not in (list, tuple):
2129
raise AssertionError("Parameter 'shape' should be "
2130
"a list or a tuple. Got %r instead" % (shape,))
2131
# It's OK to just create them using forward slashes on windows.
2132
if transport is None or transport.is_readonly():
2133
transport = get_transport(".")
2135
self.assert_(isinstance(name, basestring))
2137
transport.mkdir(urlutils.escape(name[:-1]))
2139
if line_endings == 'binary':
2141
elif line_endings == 'native':
2144
raise errors.BzrError(
2145
'Invalid line ending request %r' % line_endings)
2146
content = "contents of %s%s" % (name.encode('utf-8'), end)
2147
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2149
def build_tree_contents(self, shape):
2150
build_tree_contents(shape)
2152
def assertInWorkingTree(self, path, root_path='.', tree=None):
2153
"""Assert whether path or paths are in the WorkingTree"""
2155
tree = workingtree.WorkingTree.open(root_path)
2156
if not isinstance(path, basestring):
2158
self.assertInWorkingTree(p, tree=tree)
2160
self.assertIsNot(tree.path2id(path), None,
2161
path+' not in working tree.')
2163
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2164
"""Assert whether path or paths are not in the WorkingTree"""
2166
tree = workingtree.WorkingTree.open(root_path)
2167
if not isinstance(path, basestring):
2169
self.assertNotInWorkingTree(p,tree=tree)
2171
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2174
class TestCaseWithTransport(TestCaseInTempDir):
2175
"""A test case that provides get_url and get_readonly_url facilities.
2177
These back onto two transport servers, one for readonly access and one for
2180
If no explicit class is provided for readonly access, a
2181
ReadonlyTransportDecorator is used instead which allows the use of non disk
2182
based read write transports.
2184
If an explicit class is provided for readonly access, that server and the
2185
readwrite one must both define get_url() as resolving to os.getcwd().
2188
def get_vfs_only_server(self):
2189
"""See TestCaseWithMemoryTransport.
2191
This is useful for some tests with specific servers that need
2194
if self.__vfs_server is None:
2195
self.__vfs_server = self.vfs_transport_factory()
2196
self.__vfs_server.setUp()
2197
self.addCleanup(self.__vfs_server.tearDown)
2198
return self.__vfs_server
2200
def make_branch_and_tree(self, relpath, format=None):
2201
"""Create a branch on the transport and a tree locally.
2203
If the transport is not a LocalTransport, the Tree can't be created on
2204
the transport. In that case if the vfs_transport_factory is
2205
LocalURLServer the working tree is created in the local
2206
directory backing the transport, and the returned tree's branch and
2207
repository will also be accessed locally. Otherwise a lightweight
2208
checkout is created and returned.
2210
:param format: The BzrDirFormat.
2211
:returns: the WorkingTree.
2213
# TODO: always use the local disk path for the working tree,
2214
# this obviously requires a format that supports branch references
2215
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2217
b = self.make_branch(relpath, format=format)
2219
return b.bzrdir.create_workingtree()
2220
except errors.NotLocalUrl:
2221
# We can only make working trees locally at the moment. If the
2222
# transport can't support them, then we keep the non-disk-backed
2223
# branch and create a local checkout.
2224
if self.vfs_transport_factory is LocalURLServer:
2225
# the branch is colocated on disk, we cannot create a checkout.
2226
# hopefully callers will expect this.
2227
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2228
wt = local_controldir.create_workingtree()
2229
if wt.branch._format != b._format:
2231
# Make sure that assigning to wt._branch fixes wt.branch,
2232
# in case the implementation details of workingtree objects
2234
self.assertIs(b, wt.branch)
2237
return b.create_checkout(relpath, lightweight=True)
2239
def assertIsDirectory(self, relpath, transport):
2240
"""Assert that relpath within transport is a directory.
2242
This may not be possible on all transports; in that case it propagates
2243
a TransportNotPossible.
2246
mode = transport.stat(relpath).st_mode
2247
except errors.NoSuchFile:
2248
self.fail("path %s is not a directory; no such file"
2250
if not stat.S_ISDIR(mode):
2251
self.fail("path %s is not a directory; has mode %#o"
2254
def assertTreesEqual(self, left, right):
2255
"""Check that left and right have the same content and properties."""
2256
# we use a tree delta to check for equality of the content, and we
2257
# manually check for equality of other things such as the parents list.
2258
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2259
differences = left.changes_from(right)
2260
self.assertFalse(differences.has_changed(),
2261
"Trees %r and %r are different: %r" % (left, right, differences))
2264
super(TestCaseWithTransport, self).setUp()
2265
self.__vfs_server = None
2268
class ChrootedTestCase(TestCaseWithTransport):
2269
"""A support class that provides readonly urls outside the local namespace.
2271
This is done by checking if self.transport_server is a MemoryServer. if it
2272
is then we are chrooted already, if it is not then an HttpServer is used
2275
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2276
be used without needed to redo it when a different
2277
subclass is in use ?
2281
super(ChrootedTestCase, self).setUp()
2282
if not self.vfs_transport_factory == MemoryServer:
2283
self.transport_readonly_server = HttpServer
2286
def condition_id_re(pattern):
2287
"""Create a condition filter which performs a re check on a test's id.
2289
:param pattern: A regular expression string.
2290
:return: A callable that returns True if the re matches.
2292
filter_re = re.compile(pattern)
2293
def condition(test):
2295
return filter_re.search(test_id)
2299
def condition_isinstance(klass_or_klass_list):
2300
"""Create a condition filter which returns isinstance(param, klass).
2302
:return: A callable which when called with one parameter obj return the
2303
result of isinstance(obj, klass_or_klass_list).
2306
return isinstance(obj, klass_or_klass_list)
2310
def condition_id_in_list(id_list):
2311
"""Create a condition filter which verify that test's id in a list.
2313
:param id_list: A TestIdList object.
2314
:return: A callable that returns True if the test's id appears in the list.
2316
def condition(test):
2317
return id_list.includes(test.id())
2321
def condition_id_startswith(starts):
2322
"""Create a condition filter verifying that test's id starts with a string.
2324
:param starts: A list of string.
2325
:return: A callable that returns True if the test's id starts with one of
2328
def condition(test):
2329
for start in starts:
2330
if test.id().startswith(start):
2336
def exclude_tests_by_condition(suite, condition):
2337
"""Create a test suite which excludes some tests from suite.
2339
:param suite: The suite to get tests from.
2340
:param condition: A callable whose result evaluates True when called with a
2341
test case which should be excluded from the result.
2342
:return: A suite which contains the tests found in suite that fail
2346
for test in iter_suite_tests(suite):
2347
if not condition(test):
2349
return TestUtil.TestSuite(result)
2352
def filter_suite_by_condition(suite, condition):
2353
"""Create a test suite by filtering another one.
2355
:param suite: The source suite.
2356
:param condition: A callable whose result evaluates True when called with a
2357
test case which should be included in the result.
2358
:return: A suite which contains the tests found in suite that pass
2362
for test in iter_suite_tests(suite):
2365
return TestUtil.TestSuite(result)
2368
def filter_suite_by_re(suite, pattern):
2369
"""Create a test suite by filtering another one.
2371
:param suite: the source suite
2372
:param pattern: pattern that names must match
2373
:returns: the newly created suite
2375
condition = condition_id_re(pattern)
2376
result_suite = filter_suite_by_condition(suite, condition)
2380
def filter_suite_by_id_list(suite, test_id_list):
2381
"""Create a test suite by filtering another one.
2383
:param suite: The source suite.
2384
:param test_id_list: A list of the test ids to keep as strings.
2385
:returns: the newly created suite
2387
condition = condition_id_in_list(test_id_list)
2388
result_suite = filter_suite_by_condition(suite, condition)
2392
def filter_suite_by_id_startswith(suite, start):
2393
"""Create a test suite by filtering another one.
2395
:param suite: The source suite.
2396
:param start: A list of string the test id must start with one of.
2397
:returns: the newly created suite
2399
condition = condition_id_startswith(start)
2400
result_suite = filter_suite_by_condition(suite, condition)
2404
def exclude_tests_by_re(suite, pattern):
2405
"""Create a test suite which excludes some tests from suite.
2407
:param suite: The suite to get tests from.
2408
:param pattern: A regular expression string. Test ids that match this
2409
pattern will be excluded from the result.
2410
:return: A TestSuite that contains all the tests from suite without the
2411
tests that matched pattern. The order of tests is the same as it was in
2414
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2417
def preserve_input(something):
2418
"""A helper for performing test suite transformation chains.
2420
:param something: Anything you want to preserve.
2426
def randomize_suite(suite):
2427
"""Return a new TestSuite with suite's tests in random order.
2429
The tests in the input suite are flattened into a single suite in order to
2430
accomplish this. Any nested TestSuites are removed to provide global
2433
tests = list(iter_suite_tests(suite))
2434
random.shuffle(tests)
2435
return TestUtil.TestSuite(tests)
2438
def split_suite_by_condition(suite, condition):
2439
"""Split a test suite into two by a condition.
2441
:param suite: The suite to split.
2442
:param condition: The condition to match on. Tests that match this
2443
condition are returned in the first test suite, ones that do not match
2444
are in the second suite.
2445
:return: A tuple of two test suites, where the first contains tests from
2446
suite matching the condition, and the second contains the remainder
2447
from suite. The order within each output suite is the same as it was in
2452
for test in iter_suite_tests(suite):
2454
matched.append(test)
2456
did_not_match.append(test)
2457
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2460
def split_suite_by_re(suite, pattern):
2461
"""Split a test suite into two by a regular expression.
2463
:param suite: The suite to split.
2464
:param pattern: A regular expression string. Test ids that match this
2465
pattern will be in the first test suite returned, and the others in the
2466
second test suite returned.
2467
:return: A tuple of two test suites, where the first contains tests from
2468
suite matching pattern, and the second contains the remainder from
2469
suite. The order within each output suite is the same as it was in
2472
return split_suite_by_condition(suite, condition_id_re(pattern))
2475
def run_suite(suite, name='test', verbose=False, pattern=".*",
2476
stop_on_failure=False,
2477
transport=None, lsprof_timed=None, bench_history=None,
2478
matching_tests_first=None,
2481
exclude_pattern=None,
2483
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2488
runner = TextTestRunner(stream=sys.stdout,
2490
verbosity=verbosity,
2491
bench_history=bench_history,
2492
list_only=list_only,
2494
runner.stop_on_failure=stop_on_failure
2495
# Initialise the random number generator and display the seed used.
2496
# We convert the seed to a long to make it reuseable across invocations.
2497
random_order = False
2498
if random_seed is not None:
2500
if random_seed == "now":
2501
random_seed = long(time.time())
2503
# Convert the seed to a long if we can
2505
random_seed = long(random_seed)
2508
runner.stream.writeln("Randomizing test order using seed %s\n" %
2510
random.seed(random_seed)
2511
# Customise the list of tests if requested
2512
if exclude_pattern is not None:
2513
suite = exclude_tests_by_re(suite, exclude_pattern)
2515
order_changer = randomize_suite
2517
order_changer = preserve_input
2518
if pattern != '.*' or random_order:
2519
if matching_tests_first:
2520
suites = map(order_changer, split_suite_by_re(suite, pattern))
2521
suite = TestUtil.TestSuite(suites)
2523
suite = order_changer(filter_suite_by_re(suite, pattern))
2525
result = runner.run(suite)
2528
return result.wasStrictlySuccessful()
2530
return result.wasSuccessful()
2533
# Controlled by "bzr selftest -E=..." option
2534
selftest_debug_flags = set()
2537
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2539
test_suite_factory=None,
2542
matching_tests_first=None,
2545
exclude_pattern=None,
2551
"""Run the whole test suite under the enhanced runner"""
2552
# XXX: Very ugly way to do this...
2553
# Disable warning about old formats because we don't want it to disturb
2554
# any blackbox tests.
2555
from bzrlib import repository
2556
repository._deprecation_warning_done = True
2558
global default_transport
2559
if transport is None:
2560
transport = default_transport
2561
old_transport = default_transport
2562
default_transport = transport
2563
global selftest_debug_flags
2564
old_debug_flags = selftest_debug_flags
2565
if debug_flags is not None:
2566
selftest_debug_flags = set(debug_flags)
2568
if load_list is None:
2571
keep_only = load_test_id_list(load_list)
2572
if test_suite_factory is None:
2573
suite = test_suite(keep_only, starting_with)
2575
suite = test_suite_factory()
2576
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2577
stop_on_failure=stop_on_failure,
2578
transport=transport,
2579
lsprof_timed=lsprof_timed,
2580
bench_history=bench_history,
2581
matching_tests_first=matching_tests_first,
2582
list_only=list_only,
2583
random_seed=random_seed,
2584
exclude_pattern=exclude_pattern,
2587
default_transport = old_transport
2588
selftest_debug_flags = old_debug_flags
2591
def load_test_id_list(file_name):
2592
"""Load a test id list from a text file.
2594
The format is one test id by line. No special care is taken to impose
2595
strict rules, these test ids are used to filter the test suite so a test id
2596
that do not match an existing test will do no harm. This allows user to add
2597
comments, leave blank lines, etc.
2601
ftest = open(file_name, 'rt')
2603
if e.errno != errno.ENOENT:
2606
raise errors.NoSuchFile(file_name)
2608
for test_name in ftest.readlines():
2609
test_list.append(test_name.strip())
2614
def suite_matches_id_list(test_suite, id_list):
2615
"""Warns about tests not appearing or appearing more than once.
2617
:param test_suite: A TestSuite object.
2618
:param test_id_list: The list of test ids that should be found in
2621
:return: (absents, duplicates) absents is a list containing the test found
2622
in id_list but not in test_suite, duplicates is a list containing the
2623
test found multiple times in test_suite.
2625
When using a prefined test id list, it may occurs that some tests do not
2626
exist anymore or that some tests use the same id. This function warns the
2627
tester about potential problems in his workflow (test lists are volatile)
2628
or in the test suite itself (using the same id for several tests does not
2629
help to localize defects).
2631
# Build a dict counting id occurrences
2633
for test in iter_suite_tests(test_suite):
2635
tests[id] = tests.get(id, 0) + 1
2640
occurs = tests.get(id, 0)
2642
not_found.append(id)
2644
duplicates.append(id)
2646
return not_found, duplicates
2649
class TestIdList(object):
2650
"""Test id list to filter a test suite.
2652
Relying on the assumption that test ids are built as:
2653
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2654
notation, this class offers methods to :
2655
- avoid building a test suite for modules not refered to in the test list,
2656
- keep only the tests listed from the module test suite.
2659
def __init__(self, test_id_list):
2660
# When a test suite needs to be filtered against us we compare test ids
2661
# for equality, so a simple dict offers a quick and simple solution.
2662
self.tests = dict().fromkeys(test_id_list, True)
2664
# While unittest.TestCase have ids like:
2665
# <module>.<class>.<method>[(<param+)],
2666
# doctest.DocTestCase can have ids like:
2669
# <module>.<function>
2670
# <module>.<class>.<method>
2672
# Since we can't predict a test class from its name only, we settle on
2673
# a simple constraint: a test id always begins with its module name.
2676
for test_id in test_id_list:
2677
parts = test_id.split('.')
2678
mod_name = parts.pop(0)
2679
modules[mod_name] = True
2681
mod_name += '.' + part
2682
modules[mod_name] = True
2683
self.modules = modules
2685
def refers_to(self, module_name):
2686
"""Is there tests for the module or one of its sub modules."""
2687
return self.modules.has_key(module_name)
2689
def includes(self, test_id):
2690
return self.tests.has_key(test_id)
2693
class TestPrefixAliasRegistry(registry.Registry):
2694
"""A registry for test prefix aliases.
2696
This helps implement shorcuts for the --starting-with selftest
2697
option. Overriding existing prefixes is not allowed but not fatal (a
2698
warning will be emitted).
2701
def register(self, key, obj, help=None, info=None,
2702
override_existing=False):
2703
"""See Registry.register.
2705
Trying to override an existing alias causes a warning to be emitted,
2706
not a fatal execption.
2709
super(TestPrefixAliasRegistry, self).register(
2710
key, obj, help=help, info=info, override_existing=False)
2712
actual = self.get(key)
2713
note('Test prefix alias %s is already used for %s, ignoring %s'
2714
% (key, actual, obj))
2716
def resolve_alias(self, id_start):
2717
"""Replace the alias by the prefix in the given string.
2719
Using an unknown prefix is an error to help catching typos.
2721
parts = id_start.split('.')
2723
parts[0] = self.get(parts[0])
2725
raise errors.BzrCommandError(
2726
'%s is not a known test prefix alias' % parts[0])
2727
return '.'.join(parts)
2730
test_prefix_alias_registry = TestPrefixAliasRegistry()
2731
"""Registry of test prefix aliases."""
2734
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2735
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2736
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2738
# Obvious higest levels prefixes, feel free to add your own via a plugin
2739
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2740
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2741
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2742
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2743
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2746
def test_suite(keep_only=None, starting_with=None):
2747
"""Build and return TestSuite for the whole of bzrlib.
2749
:param keep_only: A list of test ids limiting the suite returned.
2751
:param starting_with: An id limiting the suite returned to the tests
2754
This function can be replaced if you need to change the default test
2755
suite on a global basis, but it is not encouraged.
2759
'bzrlib.util.tests.test_bencode',
2760
'bzrlib.tests.blackbox',
2761
'bzrlib.tests.branch_implementations',
2762
'bzrlib.tests.bzrdir_implementations',
2763
'bzrlib.tests.commands',
2764
'bzrlib.tests.inventory_implementations',
2765
'bzrlib.tests.interrepository_implementations',
2766
'bzrlib.tests.intertree_implementations',
2767
'bzrlib.tests.per_lock',
2768
'bzrlib.tests.per_repository',
2769
'bzrlib.tests.test__dirstate_helpers',
2770
'bzrlib.tests.test_ancestry',
2771
'bzrlib.tests.test_annotate',
2772
'bzrlib.tests.test_api',
2773
'bzrlib.tests.test_atomicfile',
2774
'bzrlib.tests.test_bad_files',
2775
'bzrlib.tests.test_bisect_multi',
2776
'bzrlib.tests.test_branch',
2777
'bzrlib.tests.test_branchbuilder',
2778
'bzrlib.tests.test_btree_index',
2779
'bzrlib.tests.test_bugtracker',
2780
'bzrlib.tests.test_bundle',
2781
'bzrlib.tests.test_bzrdir',
2782
'bzrlib.tests.test_cache_utf8',
2783
'bzrlib.tests.test_chunk_writer',
2784
'bzrlib.tests.test_commands',
2785
'bzrlib.tests.test_commit',
2786
'bzrlib.tests.test_commit_merge',
2787
'bzrlib.tests.test_config',
2788
'bzrlib.tests.test_conflicts',
2789
'bzrlib.tests.test_counted_lock',
2790
'bzrlib.tests.test_decorators',
2791
'bzrlib.tests.test_delta',
2792
'bzrlib.tests.test_deprecated_graph',
2793
'bzrlib.tests.test_diff',
2794
'bzrlib.tests.test_dirstate',
2795
'bzrlib.tests.test_directory_service',
2796
'bzrlib.tests.test_email_message',
2797
'bzrlib.tests.test_errors',
2798
'bzrlib.tests.test_extract',
2799
'bzrlib.tests.test_fetch',
2800
'bzrlib.tests.test_ftp_transport',
2801
'bzrlib.tests.test_generate_docs',
2802
'bzrlib.tests.test_generate_ids',
2803
'bzrlib.tests.test_globbing',
2804
'bzrlib.tests.test_gpg',
2805
'bzrlib.tests.test_graph',
2806
'bzrlib.tests.test_hashcache',
2807
'bzrlib.tests.test_help',
2808
'bzrlib.tests.test_hooks',
2809
'bzrlib.tests.test_http',
2810
'bzrlib.tests.test_http_implementations',
2811
'bzrlib.tests.test_http_response',
2812
'bzrlib.tests.test_https_ca_bundle',
2813
'bzrlib.tests.test_identitymap',
2814
'bzrlib.tests.test_ignores',
2815
'bzrlib.tests.test_index',
2816
'bzrlib.tests.test_info',
2817
'bzrlib.tests.test_inv',
2818
'bzrlib.tests.test_knit',
2819
'bzrlib.tests.test_lazy_import',
2820
'bzrlib.tests.test_lazy_regex',
2821
'bzrlib.tests.test_lockdir',
2822
'bzrlib.tests.test_lockable_files',
2823
'bzrlib.tests.test_log',
2824
'bzrlib.tests.test_lsprof',
2825
'bzrlib.tests.test_lru_cache',
2826
'bzrlib.tests.test_mail_client',
2827
'bzrlib.tests.test_memorytree',
2828
'bzrlib.tests.test_merge',
2829
'bzrlib.tests.test_merge3',
2830
'bzrlib.tests.test_merge_core',
2831
'bzrlib.tests.test_merge_directive',
2832
'bzrlib.tests.test_missing',
2833
'bzrlib.tests.test_msgeditor',
2834
'bzrlib.tests.test_multiparent',
2835
'bzrlib.tests.test_mutabletree',
2836
'bzrlib.tests.test_nonascii',
2837
'bzrlib.tests.test_options',
2838
'bzrlib.tests.test_osutils',
2839
'bzrlib.tests.test_osutils_encodings',
2840
'bzrlib.tests.test_pack',
2841
'bzrlib.tests.test_pack_repository',
2842
'bzrlib.tests.test_patch',
2843
'bzrlib.tests.test_patches',
2844
'bzrlib.tests.test_permissions',
2845
'bzrlib.tests.test_plugins',
2846
'bzrlib.tests.test_progress',
2847
'bzrlib.tests.test_read_bundle',
2848
'bzrlib.tests.test_reconfigure',
2849
'bzrlib.tests.test_reconcile',
2850
'bzrlib.tests.test_registry',
2851
'bzrlib.tests.test_remote',
2852
'bzrlib.tests.test_repository',
2853
'bzrlib.tests.per_repository_reference',
2854
'bzrlib.tests.test_revert',
2855
'bzrlib.tests.test_revision',
2856
'bzrlib.tests.test_revisionspec',
2857
'bzrlib.tests.test_revisiontree',
2858
'bzrlib.tests.test_rio',
2859
'bzrlib.tests.test_rules',
2860
'bzrlib.tests.test_sampler',
2861
'bzrlib.tests.test_selftest',
2862
'bzrlib.tests.test_setup',
2863
'bzrlib.tests.test_sftp_transport',
2864
'bzrlib.tests.test_smart',
2865
'bzrlib.tests.test_smart_add',
2866
'bzrlib.tests.test_smart_transport',
2867
'bzrlib.tests.test_smtp_connection',
2868
'bzrlib.tests.test_source',
2869
'bzrlib.tests.test_ssh_transport',
2870
'bzrlib.tests.test_status',
2871
'bzrlib.tests.test_store',
2872
'bzrlib.tests.test_strace',
2873
'bzrlib.tests.test_subsume',
2874
'bzrlib.tests.test_switch',
2875
'bzrlib.tests.test_symbol_versioning',
2876
'bzrlib.tests.test_tag',
2877
'bzrlib.tests.test_testament',
2878
'bzrlib.tests.test_textfile',
2879
'bzrlib.tests.test_textmerge',
2880
'bzrlib.tests.test_timestamp',
2881
'bzrlib.tests.test_trace',
2882
'bzrlib.tests.test_transactions',
2883
'bzrlib.tests.test_transform',
2884
'bzrlib.tests.test_transport',
2885
'bzrlib.tests.test_transport_implementations',
2886
'bzrlib.tests.test_transport_log',
2887
'bzrlib.tests.test_tree',
2888
'bzrlib.tests.test_treebuilder',
2889
'bzrlib.tests.test_tsort',
2890
'bzrlib.tests.test_tuned_gzip',
2891
'bzrlib.tests.test_ui',
2892
'bzrlib.tests.test_uncommit',
2893
'bzrlib.tests.test_upgrade',
2894
'bzrlib.tests.test_upgrade_stacked',
2895
'bzrlib.tests.test_urlutils',
2896
'bzrlib.tests.test_versionedfile',
2897
'bzrlib.tests.test_version',
2898
'bzrlib.tests.test_version_info',
2899
'bzrlib.tests.test__walkdirs_win32',
2900
'bzrlib.tests.test_weave',
2901
'bzrlib.tests.test_whitebox',
2902
'bzrlib.tests.test_win32utils',
2903
'bzrlib.tests.test_workingtree',
2904
'bzrlib.tests.test_workingtree_4',
2905
'bzrlib.tests.test_wsgi',
2906
'bzrlib.tests.test_xml',
2907
'bzrlib.tests.tree_implementations',
2908
'bzrlib.tests.workingtree_implementations',
2911
loader = TestUtil.TestLoader()
2914
starting_with = [test_prefix_alias_registry.resolve_alias(start)
2915
for start in starting_with]
2916
# We take precedence over keep_only because *at loading time* using
2917
# both options means we will load less tests for the same final result.
2918
def interesting_module(name):
2919
for start in starting_with:
2921
# Either the module name starts with the specified string
2922
name.startswith(start)
2923
# or it may contain tests starting with the specified string
2924
or start.startswith(name)
2928
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
2930
elif keep_only is not None:
2931
id_filter = TestIdList(keep_only)
2932
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2933
def interesting_module(name):
2934
return id_filter.refers_to(name)
2937
loader = TestUtil.TestLoader()
2938
def interesting_module(name):
2939
# No filtering, all modules are interesting
2942
suite = loader.suiteClass()
2944
# modules building their suite with loadTestsFromModuleNames
2945
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2947
modules_to_doctest = [
2952
'bzrlib.iterablefile',
2957
'bzrlib.symbol_versioning',
2960
'bzrlib.version_info_formats.format_custom',
2963
for mod in modules_to_doctest:
2964
if not interesting_module(mod):
2965
# No tests to keep here, move along
2968
doc_suite = doctest.DocTestSuite(mod)
2969
except ValueError, e:
2970
print '**failed to get doctest for: %s\n%s' % (mod, e)
2972
suite.addTest(doc_suite)
2974
default_encoding = sys.getdefaultencoding()
2975
for name, plugin in bzrlib.plugin.plugins().items():
2976
if not interesting_module(plugin.module.__name__):
2978
plugin_suite = plugin.test_suite()
2979
# We used to catch ImportError here and turn it into just a warning,
2980
# but really if you don't have --no-plugins this should be a failure.
2981
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2982
if plugin_suite is None:
2983
plugin_suite = plugin.load_plugin_tests(loader)
2984
if plugin_suite is not None:
2985
suite.addTest(plugin_suite)
2986
if default_encoding != sys.getdefaultencoding():
2987
bzrlib.trace.warning(
2988
'Plugin "%s" tried to reset default encoding to: %s', name,
2989
sys.getdefaultencoding())
2991
sys.setdefaultencoding(default_encoding)
2994
suite = filter_suite_by_id_startswith(suite, starting_with)
2996
if keep_only is not None:
2997
# Now that the referred modules have loaded their tests, keep only the
2999
suite = filter_suite_by_id_list(suite, id_filter)
3000
# Do some sanity checks on the id_list filtering
3001
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3003
# The tester has used both keep_only and starting_with, so he is
3004
# already aware that some tests are excluded from the list, there
3005
# is no need to tell him which.
3008
# Some tests mentioned in the list are not in the test suite. The
3009
# list may be out of date, report to the tester.
3010
for id in not_found:
3011
bzrlib.trace.warning('"%s" not found in the test suite', id)
3012
for id in duplicates:
3013
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3018
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
3019
"""Adapt all tests in some given modules to given scenarios.
3021
This is the recommended public interface for test parameterization.
3022
Typically the test_suite() method for a per-implementation test
3023
suite will call multiply_tests_from_modules and return the
3026
:param module_name_list: List of fully-qualified names of test
3028
:param scenario_iter: Iterable of pairs of (scenario_name,
3029
scenario_param_dict).
3030
:param loader: If provided, will be used instead of a new
3031
bzrlib.tests.TestLoader() instance.
3033
This returns a new TestSuite containing the cross product of
3034
all the tests in all the modules, each repeated for each scenario.
3035
Each test is adapted by adding the scenario name at the end
3036
of its name, and updating the test object's __dict__ with the
3037
scenario_param_dict.
3039
>>> r = multiply_tests_from_modules(
3040
... ['bzrlib.tests.test_sampler'],
3041
... [('one', dict(param=1)),
3042
... ('two', dict(param=2))])
3043
>>> tests = list(iter_suite_tests(r))
3047
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3053
# XXX: Isn't load_tests() a better way to provide the same functionality
3054
# without forcing a predefined TestScenarioApplier ? --vila 080215
3056
loader = TestUtil.TestLoader()
3058
suite = loader.suiteClass()
3060
adapter = TestScenarioApplier()
3061
adapter.scenarios = list(scenario_iter)
3062
adapt_modules(module_name_list, adapter, loader, suite)
3066
def multiply_scenarios(scenarios_left, scenarios_right):
3067
"""Multiply two sets of scenarios.
3069
:returns: the cartesian product of the two sets of scenarios, that is
3070
a scenario for every possible combination of a left scenario and a
3074
('%s,%s' % (left_name, right_name),
3075
dict(left_dict.items() + right_dict.items()))
3076
for left_name, left_dict in scenarios_left
3077
for right_name, right_dict in scenarios_right]
3081
def adapt_modules(mods_list, adapter, loader, suite):
3082
"""Adapt the modules in mods_list using adapter and add to suite."""
3083
tests = loader.loadTestsFromModuleNames(mods_list)
3084
adapt_tests(tests, adapter, suite)
3087
def adapt_tests(tests_list, adapter, suite):
3088
"""Adapt the tests in tests_list using adapter and add to suite."""
3089
for test in iter_suite_tests(tests_list):
3090
suite.addTests(adapter.adapt(test))
3093
def _rmtree_temp_dir(dirname):
3094
# If LANG=C we probably have created some bogus paths
3095
# which rmtree(unicode) will fail to delete
3096
# so make sure we are using rmtree(str) to delete everything
3097
# except on win32, where rmtree(str) will fail
3098
# since it doesn't have the property of byte-stream paths
3099
# (they are either ascii or mbcs)
3100
if sys.platform == 'win32':
3101
# make sure we are using the unicode win32 api
3102
dirname = unicode(dirname)
3104
dirname = dirname.encode(sys.getfilesystemencoding())
3106
osutils.rmtree(dirname)
3108
if sys.platform == 'win32' and e.errno == errno.EACCES:
3109
sys.stderr.write(('Permission denied: '
3110
'unable to remove testing dir '
3111
'%s\n' % os.path.basename(dirname)))
3116
class Feature(object):
3117
"""An operating system Feature."""
3120
self._available = None
3122
def available(self):
3123
"""Is the feature available?
3125
:return: True if the feature is available.
3127
if self._available is None:
3128
self._available = self._probe()
3129
return self._available
3132
"""Implement this method in concrete features.
3134
:return: True if the feature is available.
3136
raise NotImplementedError
3139
if getattr(self, 'feature_name', None):
3140
return self.feature_name()
3141
return self.__class__.__name__
3144
class _SymlinkFeature(Feature):
3147
return osutils.has_symlinks()
3149
def feature_name(self):
3152
SymlinkFeature = _SymlinkFeature()
3155
class _HardlinkFeature(Feature):
3158
return osutils.has_hardlinks()
3160
def feature_name(self):
3163
HardlinkFeature = _HardlinkFeature()
3166
class _OsFifoFeature(Feature):
3169
return getattr(os, 'mkfifo', None)
3171
def feature_name(self):
3172
return 'filesystem fifos'
3174
OsFifoFeature = _OsFifoFeature()
3177
class _UnicodeFilenameFeature(Feature):
3178
"""Does the filesystem support Unicode filenames?"""
3182
# Check for character combinations unlikely to be covered by any
3183
# single non-unicode encoding. We use the characters
3184
# - greek small letter alpha (U+03B1) and
3185
# - braille pattern dots-123456 (U+283F).
3186
os.stat(u'\u03b1\u283f')
3187
except UnicodeEncodeError:
3189
except (IOError, OSError):
3190
# The filesystem allows the Unicode filename but the file doesn't
3194
# The filesystem allows the Unicode filename and the file exists,
3198
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3201
class TestScenarioApplier(object):
3202
"""A tool to apply scenarios to tests."""
3204
def adapt(self, test):
3205
"""Return a TestSuite containing a copy of test for each scenario."""
3206
result = unittest.TestSuite()
3207
for scenario in self.scenarios:
3208
result.addTest(self.adapt_test_to_scenario(test, scenario))
3211
def adapt_test_to_scenario(self, test, scenario):
3212
"""Copy test and apply scenario to it.
3214
:param test: A test to adapt.
3215
:param scenario: A tuple describing the scenarion.
3216
The first element of the tuple is the new test id.
3217
The second element is a dict containing attributes to set on the
3219
:return: The adapted test.
3221
from copy import deepcopy
3222
new_test = deepcopy(test)
3223
for name, value in scenario[1].items():
3224
setattr(new_test, name, value)
3225
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3226
new_test.id = lambda: new_id
3230
def probe_unicode_in_user_encoding():
3231
"""Try to encode several unicode strings to use in unicode-aware tests.
3232
Return first successfull match.
3234
:return: (unicode value, encoded plain string value) or (None, None)
3236
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3237
for uni_val in possible_vals:
3239
str_val = uni_val.encode(bzrlib.user_encoding)
3240
except UnicodeEncodeError:
3241
# Try a different character
3244
return uni_val, str_val
3248
def probe_bad_non_ascii(encoding):
3249
"""Try to find [bad] character with code [128..255]
3250
that cannot be decoded to unicode in some encoding.
3251
Return None if all non-ascii characters is valid
3254
for i in xrange(128, 256):
3257
char.decode(encoding)
3258
except UnicodeDecodeError:
3263
class _FTPServerFeature(Feature):
3264
"""Some tests want an FTP Server, check if one is available.
3266
Right now, the only way this is available is if 'medusa' is installed.
3267
http://www.amk.ca/python/code/medusa.html
3272
import bzrlib.tests.ftp_server
3277
def feature_name(self):
3280
FTPServerFeature = _FTPServerFeature()
3283
class _UnicodeFilename(Feature):
3284
"""Does the filesystem support Unicode filenames?"""
3289
except UnicodeEncodeError:
3291
except (IOError, OSError):
3292
# The filesystem allows the Unicode filename but the file doesn't
3296
# The filesystem allows the Unicode filename and the file exists,
3300
UnicodeFilename = _UnicodeFilename()
3303
class _UTF8Filesystem(Feature):
3304
"""Is the filesystem UTF-8?"""
3307
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3311
UTF8Filesystem = _UTF8Filesystem()
3314
class _CaseInsensitiveFilesystemFeature(Feature):
3315
"""Check if underlying filesystem is case-insensitive
3316
(e.g. on Windows, Cygwin, MacOS)
3320
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3321
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3322
TestCaseWithMemoryTransport.TEST_ROOT = root
3324
root = TestCaseWithMemoryTransport.TEST_ROOT
3325
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3327
name_a = osutils.pathjoin(tdir, 'a')
3328
name_A = osutils.pathjoin(tdir, 'A')
3330
result = osutils.isdir(name_A)
3331
_rmtree_temp_dir(tdir)
3334
def feature_name(self):
3335
return 'case-insensitive filesystem'
3337
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
