1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
28
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
76
from bzrlib.revision import common_ancestor
78
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (
30
88
import bzrlib.trace
35
MODULES_TO_DOCTEST = []
37
from logging import debug, warning, error
89
from bzrlib.transport import get_transport
90
import bzrlib.transport
91
from bzrlib.transport.local import LocalURLServer
92
from bzrlib.transport.memory import MemoryServer
93
from bzrlib.transport.readonly import ReadonlyServer
94
from bzrlib.trace import mutter, note
95
from bzrlib.tests import TestUtil
96
from bzrlib.tests.http_server import HttpServer
97
from bzrlib.tests.TestUtil import (
101
from bzrlib.tests.treeshape import build_tree_contents
102
import bzrlib.version_info_formats.format_custom
103
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = LocalURLServer
113
def packages_to_test():
114
"""Return a list of packages to test.
116
The packages are not globally imported so that import failures are
117
triggered when running selftest, not when importing the command.
120
import bzrlib.tests.blackbox
121
import bzrlib.tests.branch_implementations
122
import bzrlib.tests.bzrdir_implementations
123
import bzrlib.tests.commands
124
import bzrlib.tests.interrepository_implementations
125
import bzrlib.tests.interversionedfile_implementations
126
import bzrlib.tests.intertree_implementations
127
import bzrlib.tests.inventory_implementations
128
import bzrlib.tests.per_lock
129
import bzrlib.tests.repository_implementations
130
import bzrlib.tests.revisionstore_implementations
131
import bzrlib.tests.tree_implementations
132
import bzrlib.tests.workingtree_implementations
135
bzrlib.tests.blackbox,
136
bzrlib.tests.branch_implementations,
137
bzrlib.tests.bzrdir_implementations,
138
bzrlib.tests.commands,
139
bzrlib.tests.interrepository_implementations,
140
bzrlib.tests.interversionedfile_implementations,
141
bzrlib.tests.intertree_implementations,
142
bzrlib.tests.inventory_implementations,
143
bzrlib.tests.per_lock,
144
bzrlib.tests.repository_implementations,
145
bzrlib.tests.revisionstore_implementations,
146
bzrlib.tests.tree_implementations,
147
bzrlib.tests.workingtree_implementations,
151
class ExtendedTestResult(unittest._TextTestResult):
152
"""Accepts, reports and accumulates the results of running tests.
154
Compared to the unittest version this class adds support for
155
profiling, benchmarking, stopping as soon as a test fails, and
156
skipping tests. There are further-specialized subclasses for
157
different types of display.
159
When a test finishes, in whatever way, it calls one of the addSuccess,
160
addFailure or addError classes. These in turn may redirect to a more
161
specific case for the special test results supported by our extended
164
Note that just one of these objects is fed the results from many tests.
169
def __init__(self, stream, descriptions, verbosity,
173
"""Construct new TestResult.
175
:param bench_history: Optionally, a writable file object to accumulate
178
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
179
if bench_history is not None:
180
from bzrlib.version import _get_bzr_source_tree
181
src_tree = _get_bzr_source_tree()
184
revision_id = src_tree.get_parent_ids()[0]
186
# XXX: if this is a brand new tree, do the same as if there
190
# XXX: If there's no branch, what should we do?
192
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
193
self._bench_history = bench_history
194
self.ui = ui.ui_factory
195
self.num_tests = num_tests
197
self.failure_count = 0
198
self.known_failure_count = 0
200
self.not_applicable_count = 0
201
self.unsupported = {}
203
self._overall_start_time = time.time()
205
def _extractBenchmarkTime(self, testCase):
206
"""Add a benchmark time for the current test case."""
207
return getattr(testCase, "_benchtime", None)
209
def _elapsedTestTimeString(self):
210
"""Return a time string for the overall time the current test has taken."""
211
return self._formatTime(time.time() - self._start_time)
213
def _testTimeString(self, testCase):
214
benchmark_time = self._extractBenchmarkTime(testCase)
215
if benchmark_time is not None:
217
self._formatTime(benchmark_time),
218
self._elapsedTestTimeString())
220
return " %s" % self._elapsedTestTimeString()
222
def _formatTime(self, seconds):
223
"""Format seconds as milliseconds with leading spaces."""
224
# some benchmarks can take thousands of seconds to run, so we need 8
226
return "%8dms" % (1000 * seconds)
228
def _shortened_test_description(self, test):
230
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
233
def startTest(self, test):
234
unittest.TestResult.startTest(self, test)
235
self.report_test_start(test)
236
test.number = self.count
237
self._recordTestStartTime()
239
def _recordTestStartTime(self):
240
"""Record that a test has started."""
241
self._start_time = time.time()
243
def _cleanupLogFile(self, test):
244
# We can only do this if we have one of our TestCases, not if
246
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
247
if setKeepLogfile is not None:
250
def addError(self, test, err):
251
"""Tell result that test finished with an error.
253
Called from the TestCase run() method when the test
254
fails with an unexpected error.
256
self._testConcluded(test)
257
if isinstance(err[1], TestSkipped):
258
return self._addSkipped(test, err)
259
elif isinstance(err[1], UnavailableFeature):
260
return self.addNotSupported(test, err[1].args[0])
262
self._cleanupLogFile(test)
263
unittest.TestResult.addError(self, test, err)
264
self.error_count += 1
265
self.report_error(test, err)
269
def addFailure(self, test, err):
270
"""Tell result that test failed.
272
Called from the TestCase run() method when the test
273
fails because e.g. an assert() method failed.
275
self._testConcluded(test)
276
if isinstance(err[1], KnownFailure):
277
return self._addKnownFailure(test, err)
279
self._cleanupLogFile(test)
280
unittest.TestResult.addFailure(self, test, err)
281
self.failure_count += 1
282
self.report_failure(test, err)
286
def addSuccess(self, test):
287
"""Tell result that test completed successfully.
289
Called from the TestCase run()
291
self._testConcluded(test)
292
if self._bench_history is not None:
293
benchmark_time = self._extractBenchmarkTime(test)
294
if benchmark_time is not None:
295
self._bench_history.write("%s %s\n" % (
296
self._formatTime(benchmark_time),
298
self.report_success(test)
299
self._cleanupLogFile(test)
300
unittest.TestResult.addSuccess(self, test)
301
test._log_contents = ''
303
def _testConcluded(self, test):
304
"""Common code when a test has finished.
306
Called regardless of whether it succeded, failed, etc.
310
def _addKnownFailure(self, test, err):
311
self.known_failure_count += 1
312
self.report_known_failure(test, err)
314
def addNotSupported(self, test, feature):
315
"""The test will not be run because of a missing feature.
317
# this can be called in two different ways: it may be that the
318
# test started running, and then raised (through addError)
319
# UnavailableFeature. Alternatively this method can be called
320
# while probing for features before running the tests; in that
321
# case we will see startTest and stopTest, but the test will never
323
self.unsupported.setdefault(str(feature), 0)
324
self.unsupported[str(feature)] += 1
325
self.report_unsupported(test, feature)
327
def _addSkipped(self, test, skip_excinfo):
328
if isinstance(skip_excinfo[1], TestNotApplicable):
329
self.not_applicable_count += 1
330
self.report_not_applicable(test, skip_excinfo)
333
self.report_skip(test, skip_excinfo)
336
except KeyboardInterrupt:
339
self.addError(test, test._exc_info())
341
# seems best to treat this as success from point-of-view of unittest
342
# -- it actually does nothing so it barely matters :)
343
unittest.TestResult.addSuccess(self, test)
344
test._log_contents = ''
346
def printErrorList(self, flavour, errors):
347
for test, err in errors:
348
self.stream.writeln(self.separator1)
349
self.stream.write("%s: " % flavour)
350
self.stream.writeln(self.getDescription(test))
351
if getattr(test, '_get_log', None) is not None:
352
self.stream.write('\n')
354
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
355
self.stream.write('\n')
356
self.stream.write(test._get_log())
357
self.stream.write('\n')
359
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
360
self.stream.write('\n')
361
self.stream.writeln(self.separator2)
362
self.stream.writeln("%s" % err)
367
def report_cleaning_up(self):
370
def report_success(self, test):
373
def wasStrictlySuccessful(self):
374
if self.unsupported or self.known_failure_count:
376
return self.wasSuccessful()
379
class TextTestResult(ExtendedTestResult):
380
"""Displays progress and results of tests in text form"""
382
def __init__(self, stream, descriptions, verbosity,
387
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
388
bench_history, num_tests)
390
self.pb = self.ui.nested_progress_bar()
391
self._supplied_pb = False
394
self._supplied_pb = True
395
self.pb.show_pct = False
396
self.pb.show_spinner = False
397
self.pb.show_eta = False,
398
self.pb.show_count = False
399
self.pb.show_bar = False
401
def report_starting(self):
402
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
404
def _progress_prefix_text(self):
405
# the longer this text, the less space we have to show the test
407
a = '[%d' % self.count # total that have been run
408
# tests skipped as known not to be relevant are not important enough
410
## if self.skip_count:
411
## a += ', %d skip' % self.skip_count
412
## if self.known_failure_count:
413
## a += '+%dX' % self.known_failure_count
414
if self.num_tests is not None:
415
a +='/%d' % self.num_tests
417
runtime = time.time() - self._overall_start_time
419
a += '%dm%ds' % (runtime / 60, runtime % 60)
423
a += ', %d err' % self.error_count
424
if self.failure_count:
425
a += ', %d fail' % self.failure_count
427
a += ', %d missing' % len(self.unsupported)
431
def report_test_start(self, test):
434
self._progress_prefix_text()
436
+ self._shortened_test_description(test))
438
def _test_description(self, test):
439
return self._shortened_test_description(test)
441
def report_error(self, test, err):
442
self.pb.note('ERROR: %s\n %s\n',
443
self._test_description(test),
447
def report_failure(self, test, err):
448
self.pb.note('FAIL: %s\n %s\n',
449
self._test_description(test),
453
def report_known_failure(self, test, err):
454
self.pb.note('XFAIL: %s\n%s\n',
455
self._test_description(test), err[1])
457
def report_skip(self, test, skip_excinfo):
460
def report_not_applicable(self, test, skip_excinfo):
463
def report_unsupported(self, test, feature):
464
"""test cannot be run because feature is missing."""
466
def report_cleaning_up(self):
467
self.pb.update('cleaning up...')
470
if not self._supplied_pb:
474
class VerboseTestResult(ExtendedTestResult):
475
"""Produce long output, with one line per test run plus times"""
477
def _ellipsize_to_right(self, a_string, final_width):
478
"""Truncate and pad a string, keeping the right hand side"""
479
if len(a_string) > final_width:
480
result = '...' + a_string[3-final_width:]
483
return result.ljust(final_width)
485
def report_starting(self):
486
self.stream.write('running %d tests...\n' % self.num_tests)
488
def report_test_start(self, test):
490
name = self._shortened_test_description(test)
491
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
492
# numbers, plus a trailing blank
493
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
494
self.stream.write(self._ellipsize_to_right(name,
495
osutils.terminal_width()-30))
498
def _error_summary(self, err):
500
return '%s%s' % (indent, err[1])
502
def report_error(self, test, err):
503
self.stream.writeln('ERROR %s\n%s'
504
% (self._testTimeString(test),
505
self._error_summary(err)))
507
def report_failure(self, test, err):
508
self.stream.writeln(' FAIL %s\n%s'
509
% (self._testTimeString(test),
510
self._error_summary(err)))
512
def report_known_failure(self, test, err):
513
self.stream.writeln('XFAIL %s\n%s'
514
% (self._testTimeString(test),
515
self._error_summary(err)))
517
def report_success(self, test):
518
self.stream.writeln(' OK %s' % self._testTimeString(test))
519
for bench_called, stats in getattr(test, '_benchcalls', []):
520
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
521
stats.pprint(file=self.stream)
522
# flush the stream so that we get smooth output. This verbose mode is
523
# used to show the output in PQM.
526
def report_skip(self, test, skip_excinfo):
527
self.stream.writeln(' SKIP %s\n%s'
528
% (self._testTimeString(test),
529
self._error_summary(skip_excinfo)))
531
def report_not_applicable(self, test, skip_excinfo):
532
self.stream.writeln(' N/A %s\n%s'
533
% (self._testTimeString(test),
534
self._error_summary(skip_excinfo)))
536
def report_unsupported(self, test, feature):
537
"""test cannot be run because feature is missing."""
538
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
539
%(self._testTimeString(test), feature))
542
class TextTestRunner(object):
543
stop_on_failure = False
552
self.stream = unittest._WritelnDecorator(stream)
553
self.descriptions = descriptions
554
self.verbosity = verbosity
555
self._bench_history = bench_history
556
self.list_only = list_only
559
"Run the given test case or test suite."
560
startTime = time.time()
561
if self.verbosity == 1:
562
result_class = TextTestResult
563
elif self.verbosity >= 2:
564
result_class = VerboseTestResult
565
result = result_class(self.stream,
568
bench_history=self._bench_history,
569
num_tests=test.countTestCases(),
571
result.stop_early = self.stop_on_failure
572
result.report_starting()
574
if self.verbosity >= 2:
575
self.stream.writeln("Listing tests only ...\n")
577
for t in iter_suite_tests(test):
578
self.stream.writeln("%s" % (t.id()))
580
actionTaken = "Listed"
583
run = result.testsRun
585
stopTime = time.time()
586
timeTaken = stopTime - startTime
588
self.stream.writeln(result.separator2)
589
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
590
run, run != 1 and "s" or "", timeTaken))
591
self.stream.writeln()
592
if not result.wasSuccessful():
593
self.stream.write("FAILED (")
594
failed, errored = map(len, (result.failures, result.errors))
596
self.stream.write("failures=%d" % failed)
598
if failed: self.stream.write(", ")
599
self.stream.write("errors=%d" % errored)
600
if result.known_failure_count:
601
if failed or errored: self.stream.write(", ")
602
self.stream.write("known_failure_count=%d" %
603
result.known_failure_count)
604
self.stream.writeln(")")
606
if result.known_failure_count:
607
self.stream.writeln("OK (known_failures=%d)" %
608
result.known_failure_count)
610
self.stream.writeln("OK")
611
if result.skip_count > 0:
612
skipped = result.skip_count
613
self.stream.writeln('%d test%s skipped' %
614
(skipped, skipped != 1 and "s" or ""))
615
if result.unsupported:
616
for feature, count in sorted(result.unsupported.items()):
617
self.stream.writeln("Missing feature '%s' skipped %d tests." %
623
def iter_suite_tests(suite):
624
"""Return all tests in a suite, recursing through nested suites"""
625
for item in suite._tests:
626
if isinstance(item, unittest.TestCase):
628
elif isinstance(item, unittest.TestSuite):
629
for r in iter_suite_tests(item):
632
raise Exception('unknown object %r inside test suite %r'
636
class TestSkipped(Exception):
637
"""Indicates that a test was intentionally skipped, rather than failing."""
640
class TestNotApplicable(TestSkipped):
641
"""A test is not applicable to the situation where it was run.
643
This is only normally raised by parameterized tests, if they find that
644
the instance they're constructed upon does not support one aspect
649
class KnownFailure(AssertionError):
650
"""Indicates that a test failed in a precisely expected manner.
652
Such failures dont block the whole test suite from passing because they are
653
indicators of partially completed code or of future work. We have an
654
explicit error for them so that we can ensure that they are always visible:
655
KnownFailures are always shown in the output of bzr selftest.
659
class UnavailableFeature(Exception):
660
"""A feature required for this test was not available.
662
The feature should be used to construct the exception.
39
666
class CommandFailed(Exception):
670
class StringIOWrapper(object):
671
"""A wrapper around cStringIO which just adds an encoding attribute.
673
Internally we can check sys.stdout to see what the output encoding
674
should be. However, cStringIO has no encoding attribute that we can
675
set. So we wrap it instead.
680
def __init__(self, s=None):
682
self.__dict__['_cstring'] = StringIO(s)
684
self.__dict__['_cstring'] = StringIO()
686
def __getattr__(self, name, getattr=getattr):
687
return getattr(self.__dict__['_cstring'], name)
689
def __setattr__(self, name, val):
690
if name == 'encoding':
691
self.__dict__['encoding'] = val
693
return setattr(self._cstring, name, val)
696
class TestUIFactory(ui.CLIUIFactory):
697
"""A UI Factory for testing.
699
Hide the progress bar but emit note()s.
701
Allows get_password to be tested without real tty attached.
708
super(TestUIFactory, self).__init__()
709
if stdin is not None:
710
# We use a StringIOWrapper to be able to test various
711
# encodings, but the user is still responsible to
712
# encode the string and to set the encoding attribute
713
# of StringIOWrapper.
714
self.stdin = StringIOWrapper(stdin)
716
self.stdout = sys.stdout
720
self.stderr = sys.stderr
725
"""See progress.ProgressBar.clear()."""
727
def clear_term(self):
728
"""See progress.ProgressBar.clear_term()."""
730
def clear_term(self):
731
"""See progress.ProgressBar.clear_term()."""
734
"""See progress.ProgressBar.finished()."""
736
def note(self, fmt_string, *args, **kwargs):
737
"""See progress.ProgressBar.note()."""
738
self.stdout.write((fmt_string + "\n") % args)
740
def progress_bar(self):
743
def nested_progress_bar(self):
746
def update(self, message, count=None, total=None):
747
"""See progress.ProgressBar.update()."""
749
def get_non_echoed_password(self, prompt):
750
"""Get password from stdin without trying to handle the echo mode"""
752
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
753
password = self.stdin.readline()
756
if password[-1] == '\n':
757
password = password[:-1]
42
761
class TestCase(unittest.TestCase):
43
762
"""Base class for bzr unit tests.
48
767
Error and debug log messages are redirected from their usual
49
768
location into a temporary file, the contents of which can be
50
retrieved by _get_log().
769
retrieved by _get_log(). We use a real OS file, not an in-memory object,
770
so that it can also capture file IO. When the test completes this file
771
is read into memory and removed from disk.
52
773
There are also convenience functions to invoke bzr's command-line
53
routine, and to build and check bzr trees."""
774
routine, and to build and check bzr trees.
776
In addition to the usual method of overriding tearDown(), this class also
777
allows subclasses to register functions into the _cleanups list, which is
778
run in order as the object is torn down. It's less likely this will be
779
accidentally overlooked.
782
_log_file_name = None
784
_keep_log_file = False
785
# record lsprof data when performing benchmark calls.
786
_gather_lsprof_in_benchmarks = False
787
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
788
'_log_contents', '_log_file_name', '_benchtime',
789
'_TestCase__testMethodName')
791
def __init__(self, methodName='testMethod'):
792
super(TestCase, self).__init__(methodName)
58
# this replaces the default testsweet.TestCase; we don't want logging changed
59
796
unittest.TestCase.setUp(self)
60
bzrlib.trace.disable_default_logging()
61
self._enable_file_logging()
64
def _enable_file_logging(self):
797
self._cleanEnvironment()
800
self._benchcalls = []
801
self._benchtime = None
803
self._clear_debug_flags()
805
def _clear_debug_flags(self):
806
"""Prevent externally set debug flags affecting tests.
808
Tests that want to use debug flags can just set them in the
809
debug_flags set during setup/teardown.
811
if 'selftest_debug' not in debug.debug_flags:
812
self._preserved_debug_flags = set(debug.debug_flags)
813
debug.debug_flags.clear()
814
self.addCleanup(self._restore_debug_flags)
816
def _clear_hooks(self):
817
# prevent hooks affecting tests
819
import bzrlib.smart.server
820
self._preserved_hooks = {
821
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
822
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
823
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
825
self.addCleanup(self._restoreHooks)
826
# reset all hooks to an empty instance of the appropriate type
827
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
828
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
830
def _silenceUI(self):
831
"""Turn off UI for duration of test"""
832
# by default the UI is off; tests can turn it on if they want it.
833
saved = ui.ui_factory
835
ui.ui_factory = saved
836
ui.ui_factory = ui.SilentUIFactory()
837
self.addCleanup(_restore)
839
def _ndiff_strings(self, a, b):
840
"""Return ndiff between two strings containing lines.
842
A trailing newline is added if missing to make the strings
844
if b and b[-1] != '\n':
846
if a and a[-1] != '\n':
848
difflines = difflib.ndiff(a.splitlines(True),
850
linejunk=lambda x: False,
851
charjunk=lambda x: False)
852
return ''.join(difflines)
854
def assertEqual(self, a, b, message=''):
858
except UnicodeError, e:
859
# If we can't compare without getting a UnicodeError, then
860
# obviously they are different
861
mutter('UnicodeError: %s', e)
864
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
866
pformat(a), pformat(b)))
868
assertEquals = assertEqual
870
def assertEqualDiff(self, a, b, message=None):
871
"""Assert two texts are equal, if not raise an exception.
873
This is intended for use with multi-line strings where it can
874
be hard to find the differences by eye.
876
# TODO: perhaps override assertEquals to call this for strings?
880
message = "texts not equal:\n"
881
raise AssertionError(message +
882
self._ndiff_strings(a, b))
884
def assertEqualMode(self, mode, mode_test):
885
self.assertEqual(mode, mode_test,
886
'mode mismatch %o != %o' % (mode, mode_test))
888
def assertPositive(self, val):
889
"""Assert that val is greater than 0."""
890
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
892
def assertNegative(self, val):
893
"""Assert that val is less than 0."""
894
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
896
def assertStartsWith(self, s, prefix):
897
if not s.startswith(prefix):
898
raise AssertionError('string %r does not start with %r' % (s, prefix))
900
def assertEndsWith(self, s, suffix):
901
"""Asserts that s ends with suffix."""
902
if not s.endswith(suffix):
903
raise AssertionError('string %r does not end with %r' % (s, suffix))
905
def assertContainsRe(self, haystack, needle_re):
906
"""Assert that a contains something matching a regular expression."""
907
if not re.search(needle_re, haystack):
908
if '\n' in haystack or len(haystack) > 60:
909
# a long string, format it in a more readable way
910
raise AssertionError(
911
'pattern "%s" not found in\n"""\\\n%s"""\n'
912
% (needle_re, haystack))
914
raise AssertionError('pattern "%s" not found in "%s"'
915
% (needle_re, haystack))
917
def assertNotContainsRe(self, haystack, needle_re):
918
"""Assert that a does not match a regular expression"""
919
if re.search(needle_re, haystack):
920
raise AssertionError('pattern "%s" found in "%s"'
921
% (needle_re, haystack))
923
def assertSubset(self, sublist, superlist):
924
"""Assert that every entry in sublist is present in superlist."""
925
missing = set(sublist) - set(superlist)
927
raise AssertionError("value(s) %r not present in container %r" %
928
(missing, superlist))
930
def assertListRaises(self, excClass, func, *args, **kwargs):
931
"""Fail unless excClass is raised when the iterator from func is used.
933
Many functions can return generators this makes sure
934
to wrap them in a list() call to make sure the whole generator
935
is run, and that the proper exception is raised.
938
list(func(*args, **kwargs))
942
if getattr(excClass,'__name__', None) is not None:
943
excName = excClass.__name__
945
excName = str(excClass)
946
raise self.failureException, "%s not raised" % excName
948
def assertRaises(self, excClass, callableObj, *args, **kwargs):
949
"""Assert that a callable raises a particular exception.
951
:param excClass: As for the except statement, this may be either an
952
exception class, or a tuple of classes.
953
:param callableObj: A callable, will be passed ``*args`` and
956
Returns the exception so that you can examine it.
959
callableObj(*args, **kwargs)
963
if getattr(excClass,'__name__', None) is not None:
964
excName = excClass.__name__
967
excName = str(excClass)
968
raise self.failureException, "%s not raised" % excName
970
def assertIs(self, left, right, message=None):
971
if not (left is right):
972
if message is not None:
973
raise AssertionError(message)
975
raise AssertionError("%r is not %r." % (left, right))
977
def assertIsNot(self, left, right, message=None):
979
if message is not None:
980
raise AssertionError(message)
982
raise AssertionError("%r is %r." % (left, right))
984
def assertTransportMode(self, transport, path, mode):
985
"""Fail if a path does not have mode mode.
987
If modes are not supported on this transport, the assertion is ignored.
989
if not transport._can_roundtrip_unix_modebits():
991
path_stat = transport.stat(path)
992
actual_mode = stat.S_IMODE(path_stat.st_mode)
993
self.assertEqual(mode, actual_mode,
994
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
996
def assertIsSameRealPath(self, path1, path2):
997
"""Fail if path1 and path2 points to different files"""
998
self.assertEqual(osutils.realpath(path1),
999
osutils.realpath(path2),
1000
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1002
def assertIsInstance(self, obj, kls):
1003
"""Fail if obj is not an instance of kls"""
1004
if not isinstance(obj, kls):
1005
self.fail("%r is an instance of %s rather than %s" % (
1006
obj, obj.__class__, kls))
1008
def expectFailure(self, reason, assertion, *args, **kwargs):
1009
"""Invoke a test, expecting it to fail for the given reason.
1011
This is for assertions that ought to succeed, but currently fail.
1012
(The failure is *expected* but not *wanted*.) Please be very precise
1013
about the failure you're expecting. If a new bug is introduced,
1014
AssertionError should be raised, not KnownFailure.
1016
Frequently, expectFailure should be followed by an opposite assertion.
1019
Intended to be used with a callable that raises AssertionError as the
1020
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1022
Raises KnownFailure if the test fails. Raises AssertionError if the
1027
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1029
self.assertEqual(42, dynamic_val)
1031
This means that a dynamic_val of 54 will cause the test to raise
1032
a KnownFailure. Once math is fixed and the expectFailure is removed,
1033
only a dynamic_val of 42 will allow the test to pass. Anything other
1034
than 54 or 42 will cause an AssertionError.
1037
assertion(*args, **kwargs)
1038
except AssertionError:
1039
raise KnownFailure(reason)
1041
self.fail('Unexpected success. Should have failed: %s' % reason)
1043
def assertFileEqual(self, content, path):
1044
"""Fail if path does not contain 'content'."""
1045
self.failUnlessExists(path)
1046
f = file(path, 'rb')
1051
self.assertEqualDiff(content, s)
1053
def failUnlessExists(self, path):
1054
"""Fail unless path or paths, which may be abs or relative, exist."""
1055
if not isinstance(path, basestring):
1057
self.failUnlessExists(p)
1059
self.failUnless(osutils.lexists(path),path+" does not exist")
1061
def failIfExists(self, path):
1062
"""Fail if path or paths, which may be abs or relative, exist."""
1063
if not isinstance(path, basestring):
1065
self.failIfExists(p)
1067
self.failIf(osutils.lexists(path),path+" exists")
1069
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1070
"""A helper for callDeprecated and applyDeprecated.
1072
:param a_callable: A callable to call.
1073
:param args: The positional arguments for the callable
1074
:param kwargs: The keyword arguments for the callable
1075
:return: A tuple (warnings, result). result is the result of calling
1076
a_callable(``*args``, ``**kwargs``).
1079
def capture_warnings(msg, cls=None, stacklevel=None):
1080
# we've hooked into a deprecation specific callpath,
1081
# only deprecations should getting sent via it.
1082
self.assertEqual(cls, DeprecationWarning)
1083
local_warnings.append(msg)
1084
original_warning_method = symbol_versioning.warn
1085
symbol_versioning.set_warning_method(capture_warnings)
1087
result = a_callable(*args, **kwargs)
1089
symbol_versioning.set_warning_method(original_warning_method)
1090
return (local_warnings, result)
1092
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1093
"""Call a deprecated callable without warning the user.
1095
Note that this only captures warnings raised by symbol_versioning.warn,
1096
not other callers that go direct to the warning module.
1098
To test that a deprecated method raises an error, do something like
1101
self.assertRaises(errors.ReservedId,
1102
self.applyDeprecated, zero_ninetyone,
1103
br.append_revision, 'current:')
1105
:param deprecation_format: The deprecation format that the callable
1106
should have been deprecated with. This is the same type as the
1107
parameter to deprecated_method/deprecated_function. If the
1108
callable is not deprecated with this format, an assertion error
1110
:param a_callable: A callable to call. This may be a bound method or
1111
a regular function. It will be called with ``*args`` and
1113
:param args: The positional arguments for the callable
1114
:param kwargs: The keyword arguments for the callable
1115
:return: The result of a_callable(``*args``, ``**kwargs``)
1117
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1119
expected_first_warning = symbol_versioning.deprecation_string(
1120
a_callable, deprecation_format)
1121
if len(call_warnings) == 0:
1122
self.fail("No deprecation warning generated by call to %s" %
1124
self.assertEqual(expected_first_warning, call_warnings[0])
1127
def callCatchWarnings(self, fn, *args, **kw):
1128
"""Call a callable that raises python warnings.
1130
The caller's responsible for examining the returned warnings.
1132
If the callable raises an exception, the exception is not
1133
caught and propagates up to the caller. In that case, the list
1134
of warnings is not available.
1136
:returns: ([warning_object, ...], fn_result)
1138
# XXX: This is not perfect, because it completely overrides the
1139
# warnings filters, and some code may depend on suppressing particular
1140
# warnings. It's the easiest way to insulate ourselves from -Werror,
1141
# though. -- Andrew, 20071062
1143
def _catcher(message, category, filename, lineno, file=None):
1144
# despite the name, 'message' is normally(?) a Warning subclass
1146
wlist.append(message)
1147
saved_showwarning = warnings.showwarning
1148
saved_filters = warnings.filters
1150
warnings.showwarning = _catcher
1151
warnings.filters = []
1152
result = fn(*args, **kw)
1154
warnings.showwarning = saved_showwarning
1155
warnings.filters = saved_filters
1156
return wlist, result
1158
def callDeprecated(self, expected, callable, *args, **kwargs):
1159
"""Assert that a callable is deprecated in a particular way.
1161
This is a very precise test for unusual requirements. The
1162
applyDeprecated helper function is probably more suited for most tests
1163
as it allows you to simply specify the deprecation format being used
1164
and will ensure that that is issued for the function being called.
1166
Note that this only captures warnings raised by symbol_versioning.warn,
1167
not other callers that go direct to the warning module. To catch
1168
general warnings, use callCatchWarnings.
1170
:param expected: a list of the deprecation warnings expected, in order
1171
:param callable: The callable to call
1172
:param args: The positional arguments for the callable
1173
:param kwargs: The keyword arguments for the callable
1175
call_warnings, result = self._capture_deprecation_warnings(callable,
1177
self.assertEqual(expected, call_warnings)
1180
def _startLogFile(self):
1181
"""Send bzr and test log messages to a temporary file.
1183
The file is removed as the test is torn down.
65
1185
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
67
1186
self._log_file = os.fdopen(fileno, 'w+')
69
hdlr = logging.StreamHandler(self._log_file)
70
hdlr.setLevel(logging.DEBUG)
71
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
72
logging.getLogger('').addHandler(hdlr)
73
logging.getLogger('').setLevel(logging.DEBUG)
75
debug('opened log file %s', name)
1187
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
77
1188
self._log_file_name = name
81
logging.getLogger('').removeHandler(self._log_hdlr)
82
bzrlib.trace.enable_default_logging()
83
logging.debug('%s teardown', self.id())
1189
self.addCleanup(self._finishLogFile)
1191
def _finishLogFile(self):
1192
"""Finished with the log file.
1194
Close the file and delete it, unless setKeepLogfile was called.
1196
if self._log_file is None:
1198
bzrlib.trace.pop_log_file(self._log_memento)
84
1199
self._log_file.close()
1200
self._log_file = None
1201
if not self._keep_log_file:
1202
os.remove(self._log_file_name)
1203
self._log_file_name = None
1205
def setKeepLogfile(self):
1206
"""Make the logfile not be deleted when _finishLogFile is called."""
1207
self._keep_log_file = True
1209
def addCleanup(self, callable):
1210
"""Arrange to run a callable when this case is torn down.
1212
Callables are run in the reverse of the order they are registered,
1213
ie last-in first-out.
1215
if callable in self._cleanups:
1216
raise ValueError("cleanup function %r already registered on %s"
1218
self._cleanups.append(callable)
1220
def _cleanEnvironment(self):
1222
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1223
'HOME': os.getcwd(),
1224
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1225
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1227
'BZREMAIL': None, # may still be present in the environment
1229
'BZR_PROGRESS_BAR': None,
1232
'SSH_AUTH_SOCK': None,
1236
'https_proxy': None,
1237
'HTTPS_PROXY': None,
1242
# Nobody cares about these ones AFAIK. So far at
1243
# least. If you do (care), please update this comment
1247
'BZR_REMOTE_PATH': None,
1250
self.addCleanup(self._restoreEnvironment)
1251
for name, value in new_env.iteritems():
1252
self._captureVar(name, value)
1254
def _captureVar(self, name, newvalue):
1255
"""Set an environment variable, and reset it when finished."""
1256
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1258
def _restore_debug_flags(self):
1259
debug.debug_flags.clear()
1260
debug.debug_flags.update(self._preserved_debug_flags)
1262
def _restoreEnvironment(self):
1263
for name, value in self.__old_env.iteritems():
1264
osutils.set_or_unset_env(name, value)
1266
def _restoreHooks(self):
1267
for klass, hooks in self._preserved_hooks.items():
1268
setattr(klass, 'hooks', hooks)
1270
def knownFailure(self, reason):
1271
"""This test has failed for some known reason."""
1272
raise KnownFailure(reason)
1274
def run(self, result=None):
1275
if result is None: result = self.defaultTestResult()
1276
for feature in getattr(self, '_test_needs_features', []):
1277
if not feature.available():
1278
result.startTest(self)
1279
if getattr(result, 'addNotSupported', None):
1280
result.addNotSupported(self, feature)
1282
result.addSuccess(self)
1283
result.stopTest(self)
1286
return unittest.TestCase.run(self, result)
1289
absent_attr = object()
1290
for attr_name in self.attrs_to_keep:
1291
attr = getattr(self, attr_name, absent_attr)
1292
if attr is not absent_attr:
1293
saved_attrs[attr_name] = attr
1294
self.__dict__ = saved_attrs
85
1298
unittest.TestCase.tearDown(self)
1300
def time(self, callable, *args, **kwargs):
1301
"""Run callable and accrue the time it takes to the benchmark time.
1303
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1304
this will cause lsprofile statistics to be gathered and stored in
1307
if self._benchtime is None:
1311
if not self._gather_lsprof_in_benchmarks:
1312
return callable(*args, **kwargs)
1314
# record this benchmark
1315
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1317
self._benchcalls.append(((callable, args, kwargs), stats))
1320
self._benchtime += time.time() - start
1322
def _runCleanups(self):
1323
"""Run registered cleanup functions.
1325
This should only be called from TestCase.tearDown.
1327
# TODO: Perhaps this should keep running cleanups even if
1328
# one of them fails?
1330
# Actually pop the cleanups from the list so tearDown running
1331
# twice is safe (this happens for skipped tests).
1332
while self._cleanups:
1333
self._cleanups.pop()()
88
1335
def log(self, *args):
92
"""Return as a string the log for this test"""
93
return open(self._log_file_name).read()
95
def run_bzr(self, *args, **kwargs):
1338
def _get_log(self, keep_log_file=False):
1339
"""Get the log from bzrlib.trace calls from this test.
1341
:param keep_log_file: When True, if the log is still a file on disk
1342
leave it as a file on disk. When False, if the log is still a file
1343
on disk, the log file is deleted and the log preserved as
1345
:return: A string containing the log.
1347
# flush the log file, to get all content
1349
bzrlib.trace._trace_file.flush()
1350
if self._log_contents:
1351
# XXX: this can hardly contain the content flushed above --vila
1353
return self._log_contents
1354
if self._log_file_name is not None:
1355
logfile = open(self._log_file_name)
1357
log_contents = logfile.read()
1360
if not keep_log_file:
1361
self._log_contents = log_contents
1363
os.remove(self._log_file_name)
1365
if sys.platform == 'win32' and e.errno == errno.EACCES:
1366
sys.stderr.write(('Unable to delete log file '
1367
' %r\n' % self._log_file_name))
1372
return "DELETED log file to reduce memory footprint"
1374
def requireFeature(self, feature):
1375
"""This test requires a specific feature is available.
1377
:raises UnavailableFeature: When feature is not available.
1379
if not feature.available():
1380
raise UnavailableFeature(feature)
1382
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1384
"""Run bazaar command line, splitting up a string command line."""
1385
if isinstance(args, basestring):
1386
# shlex don't understand unicode strings,
1387
# so args should be plain string (bialix 20070906)
1388
args = list(shlex.split(str(args)))
1389
return self._run_bzr_core(args, retcode=retcode,
1390
encoding=encoding, stdin=stdin, working_dir=working_dir,
1393
def _run_bzr_core(self, args, retcode, encoding, stdin,
1395
if encoding is None:
1396
encoding = bzrlib.user_encoding
1397
stdout = StringIOWrapper()
1398
stderr = StringIOWrapper()
1399
stdout.encoding = encoding
1400
stderr.encoding = encoding
1402
self.log('run bzr: %r', args)
1403
# FIXME: don't call into logging here
1404
handler = logging.StreamHandler(stderr)
1405
handler.setLevel(logging.INFO)
1406
logger = logging.getLogger('')
1407
logger.addHandler(handler)
1408
old_ui_factory = ui.ui_factory
1409
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1412
if working_dir is not None:
1413
cwd = osutils.getcwd()
1414
os.chdir(working_dir)
1417
result = self.apply_redirected(ui.ui_factory.stdin,
1419
bzrlib.commands.run_bzr_catch_user_errors,
1422
logger.removeHandler(handler)
1423
ui.ui_factory = old_ui_factory
1427
out = stdout.getvalue()
1428
err = stderr.getvalue()
1430
self.log('output:\n%r', out)
1432
self.log('errors:\n%r', err)
1433
if retcode is not None:
1434
self.assertEquals(retcode, result,
1435
message='Unexpected return code')
1438
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1439
working_dir=None, error_regexes=[], output_encoding=None):
96
1440
"""Invoke bzr, as if it were run from the command line.
1442
The argument list should not include the bzr program name - the
1443
first argument is normally the bzr command. Arguments may be
1444
passed in three ways:
1446
1- A list of strings, eg ["commit", "a"]. This is recommended
1447
when the command contains whitespace or metacharacters, or
1448
is built up at run time.
1450
2- A single string, eg "add a". This is the most convenient
1451
for hardcoded commands.
1453
This runs bzr through the interface that catches and reports
1454
errors, and with logging set to something approximating the
1455
default, so that error reporting can be checked.
98
1457
This should be the main method for tests that want to exercise the
99
1458
overall behavior of the bzr application (rather than a unit test
100
1459
or a functional test of the library.)
102
Much of the old code runs bzr by forking a new copy of Python, but
103
that is slower, harder to debug, and generally not necessary.
105
retcode = kwargs.get('retcode', 0)
106
result = self.apply_redirected(None, None, None,
107
bzrlib.commands.run_bzr, args)
108
self.assertEquals(result, retcode)
1461
This sends the stdout/stderr results into the test's log,
1462
where it may be useful for debugging. See also run_captured.
1464
:keyword stdin: A string to be used as stdin for the command.
1465
:keyword retcode: The status code the command should return;
1467
:keyword working_dir: The directory to run the command in
1468
:keyword error_regexes: A list of expected error messages. If
1469
specified they must be seen in the error output of the command.
1471
out, err = self._run_bzr_autosplit(
1476
working_dir=working_dir,
1478
for regex in error_regexes:
1479
self.assertContainsRe(err, regex)
1482
def run_bzr_error(self, error_regexes, *args, **kwargs):
1483
"""Run bzr, and check that stderr contains the supplied regexes
1485
:param error_regexes: Sequence of regular expressions which
1486
must each be found in the error output. The relative ordering
1488
:param args: command-line arguments for bzr
1489
:param kwargs: Keyword arguments which are interpreted by run_bzr
1490
This function changes the default value of retcode to be 3,
1491
since in most cases this is run when you expect bzr to fail.
1493
:return: (out, err) The actual output of running the command (in case
1494
you want to do more inspection)
1498
# Make sure that commit is failing because there is nothing to do
1499
self.run_bzr_error(['no changes to commit'],
1500
['commit', '-m', 'my commit comment'])
1501
# Make sure --strict is handling an unknown file, rather than
1502
# giving us the 'nothing to do' error
1503
self.build_tree(['unknown'])
1504
self.run_bzr_error(['Commit refused because there are unknown files'],
1505
['commit', --strict', '-m', 'my commit comment'])
1507
kwargs.setdefault('retcode', 3)
1508
kwargs['error_regexes'] = error_regexes
1509
out, err = self.run_bzr(*args, **kwargs)
1512
def run_bzr_subprocess(self, *args, **kwargs):
1513
"""Run bzr in a subprocess for testing.
1515
This starts a new Python interpreter and runs bzr in there.
1516
This should only be used for tests that have a justifiable need for
1517
this isolation: e.g. they are testing startup time, or signal
1518
handling, or early startup code, etc. Subprocess code can't be
1519
profiled or debugged so easily.
1521
:keyword retcode: The status code that is expected. Defaults to 0. If
1522
None is supplied, the status code is not checked.
1523
:keyword env_changes: A dictionary which lists changes to environment
1524
variables. A value of None will unset the env variable.
1525
The values must be strings. The change will only occur in the
1526
child, so you don't need to fix the environment after running.
1527
:keyword universal_newlines: Convert CRLF => LF
1528
:keyword allow_plugins: By default the subprocess is run with
1529
--no-plugins to ensure test reproducibility. Also, it is possible
1530
for system-wide plugins to create unexpected output on stderr,
1531
which can cause unnecessary test failures.
1533
env_changes = kwargs.get('env_changes', {})
1534
working_dir = kwargs.get('working_dir', None)
1535
allow_plugins = kwargs.get('allow_plugins', False)
1537
if isinstance(args[0], list):
1539
elif isinstance(args[0], basestring):
1540
args = list(shlex.split(args[0]))
1542
symbol_versioning.warn(zero_ninetyone %
1543
"passing varargs to run_bzr_subprocess",
1544
DeprecationWarning, stacklevel=3)
1545
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1546
working_dir=working_dir,
1547
allow_plugins=allow_plugins)
1548
# We distinguish between retcode=None and retcode not passed.
1549
supplied_retcode = kwargs.get('retcode', 0)
1550
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1551
universal_newlines=kwargs.get('universal_newlines', False),
1554
def start_bzr_subprocess(self, process_args, env_changes=None,
1555
skip_if_plan_to_signal=False,
1557
allow_plugins=False):
1558
"""Start bzr in a subprocess for testing.
1560
This starts a new Python interpreter and runs bzr in there.
1561
This should only be used for tests that have a justifiable need for
1562
this isolation: e.g. they are testing startup time, or signal
1563
handling, or early startup code, etc. Subprocess code can't be
1564
profiled or debugged so easily.
1566
:param process_args: a list of arguments to pass to the bzr executable,
1567
for example ``['--version']``.
1568
:param env_changes: A dictionary which lists changes to environment
1569
variables. A value of None will unset the env variable.
1570
The values must be strings. The change will only occur in the
1571
child, so you don't need to fix the environment after running.
1572
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1574
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1576
:returns: Popen object for the started process.
1578
if skip_if_plan_to_signal:
1579
if not getattr(os, 'kill', None):
1580
raise TestSkipped("os.kill not available.")
1582
if env_changes is None:
1586
def cleanup_environment():
1587
for env_var, value in env_changes.iteritems():
1588
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1590
def restore_environment():
1591
for env_var, value in old_env.iteritems():
1592
osutils.set_or_unset_env(env_var, value)
1594
bzr_path = self.get_bzr_path()
1597
if working_dir is not None:
1598
cwd = osutils.getcwd()
1599
os.chdir(working_dir)
1602
# win32 subprocess doesn't support preexec_fn
1603
# so we will avoid using it on all platforms, just to
1604
# make sure the code path is used, and we don't break on win32
1605
cleanup_environment()
1606
command = [sys.executable, bzr_path]
1607
if not allow_plugins:
1608
command.append('--no-plugins')
1609
command.extend(process_args)
1610
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1612
restore_environment()
1618
def _popen(self, *args, **kwargs):
1619
"""Place a call to Popen.
1621
Allows tests to override this method to intercept the calls made to
1622
Popen for introspection.
1624
return Popen(*args, **kwargs)
1626
def get_bzr_path(self):
1627
"""Return the path of the 'bzr' executable for this test suite."""
1628
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1629
if not os.path.isfile(bzr_path):
1630
# We are probably installed. Assume sys.argv is the right file
1631
bzr_path = sys.argv[0]
1634
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1635
universal_newlines=False, process_args=None):
1636
"""Finish the execution of process.
1638
:param process: the Popen object returned from start_bzr_subprocess.
1639
:param retcode: The status code that is expected. Defaults to 0. If
1640
None is supplied, the status code is not checked.
1641
:param send_signal: an optional signal to send to the process.
1642
:param universal_newlines: Convert CRLF => LF
1643
:returns: (stdout, stderr)
1645
if send_signal is not None:
1646
os.kill(process.pid, send_signal)
1647
out, err = process.communicate()
1649
if universal_newlines:
1650
out = out.replace('\r\n', '\n')
1651
err = err.replace('\r\n', '\n')
1653
if retcode is not None and retcode != process.returncode:
1654
if process_args is None:
1655
process_args = "(unknown args)"
1656
mutter('Output of bzr %s:\n%s', process_args, out)
1657
mutter('Error for bzr %s:\n%s', process_args, err)
1658
self.fail('Command bzr %s failed with retcode %s != %s'
1659
% (process_args, retcode, process.returncode))
111
1662
def check_inventory_shape(self, inv, shape):
113
Compare an inventory to a list of expected names.
1663
"""Compare an inventory to a list of expected names.
115
1665
Fail if they are not precisely equal.
156
1711
sys.stderr = real_stderr
157
1712
sys.stdin = real_stdin
160
BzrTestBase = TestCase
1714
def reduceLockdirTimeout(self):
1715
"""Reduce the default lock timeout for the duration of the test, so that
1716
if LockContention occurs during a test, it does so quickly.
1718
Tests that expect to provoke LockContention errors should call this.
1720
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1722
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1723
self.addCleanup(resetTimeout)
1724
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1726
def make_utf8_encoded_stringio(self, encoding_type=None):
1727
"""Return a StringIOWrapper instance, that will encode Unicode
1730
if encoding_type is None:
1731
encoding_type = 'strict'
1733
output_encoding = 'utf-8'
1734
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1735
sio.encoding = output_encoding
1739
class TestCaseWithMemoryTransport(TestCase):
1740
"""Common test class for tests that do not need disk resources.
1742
Tests that need disk resources should derive from TestCaseWithTransport.
1744
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1746
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1747
a directory which does not exist. This serves to help ensure test isolation
1748
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1749
must exist. However, TestCaseWithMemoryTransport does not offer local
1750
file defaults for the transport in tests, nor does it obey the command line
1751
override, so tests that accidentally write to the common directory should
1754
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1755
a .bzr directory that stops us ascending higher into the filesystem.
1761
def __init__(self, methodName='runTest'):
1762
# allow test parameterization after test construction and before test
1763
# execution. Variables that the parameterizer sets need to be
1764
# ones that are not set by setUp, or setUp will trash them.
1765
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1766
self.vfs_transport_factory = default_transport
1767
self.transport_server = None
1768
self.transport_readonly_server = None
1769
self.__vfs_server = None
1771
def get_transport(self, relpath=None):
1772
"""Return a writeable transport.
1774
This transport is for the test scratch space relative to
1777
:param relpath: a path relative to the base url.
1779
t = get_transport(self.get_url(relpath))
1780
self.assertFalse(t.is_readonly())
1783
def get_readonly_transport(self, relpath=None):
1784
"""Return a readonly transport for the test scratch space
1786
This can be used to test that operations which should only need
1787
readonly access in fact do not try to write.
1789
:param relpath: a path relative to the base url.
1791
t = get_transport(self.get_readonly_url(relpath))
1792
self.assertTrue(t.is_readonly())
1795
def create_transport_readonly_server(self):
1796
"""Create a transport server from class defined at init.
1798
This is mostly a hook for daughter classes.
1800
return self.transport_readonly_server()
1802
def get_readonly_server(self):
1803
"""Get the server instance for the readonly transport
1805
This is useful for some tests with specific servers to do diagnostics.
1807
if self.__readonly_server is None:
1808
if self.transport_readonly_server is None:
1809
# readonly decorator requested
1810
# bring up the server
1811
self.__readonly_server = ReadonlyServer()
1812
self.__readonly_server.setUp(self.get_vfs_only_server())
1814
self.__readonly_server = self.create_transport_readonly_server()
1815
self.__readonly_server.setUp(self.get_vfs_only_server())
1816
self.addCleanup(self.__readonly_server.tearDown)
1817
return self.__readonly_server
1819
def get_readonly_url(self, relpath=None):
1820
"""Get a URL for the readonly transport.
1822
This will either be backed by '.' or a decorator to the transport
1823
used by self.get_url()
1824
relpath provides for clients to get a path relative to the base url.
1825
These should only be downwards relative, not upwards.
1827
base = self.get_readonly_server().get_url()
1828
return self._adjust_url(base, relpath)
1830
def get_vfs_only_server(self):
1831
"""Get the vfs only read/write server instance.
1833
This is useful for some tests with specific servers that need
1836
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1837
is no means to override it.
1839
if self.__vfs_server is None:
1840
self.__vfs_server = MemoryServer()
1841
self.__vfs_server.setUp()
1842
self.addCleanup(self.__vfs_server.tearDown)
1843
return self.__vfs_server
1845
def get_server(self):
1846
"""Get the read/write server instance.
1848
This is useful for some tests with specific servers that need
1851
This is built from the self.transport_server factory. If that is None,
1852
then the self.get_vfs_server is returned.
1854
if self.__server is None:
1855
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1856
return self.get_vfs_only_server()
1858
# bring up a decorated means of access to the vfs only server.
1859
self.__server = self.transport_server()
1861
self.__server.setUp(self.get_vfs_only_server())
1862
except TypeError, e:
1863
# This should never happen; the try:Except here is to assist
1864
# developers having to update code rather than seeing an
1865
# uninformative TypeError.
1866
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1867
self.addCleanup(self.__server.tearDown)
1868
return self.__server
1870
def _adjust_url(self, base, relpath):
1871
"""Get a URL (or maybe a path) for the readwrite transport.
1873
This will either be backed by '.' or to an equivalent non-file based
1875
relpath provides for clients to get a path relative to the base url.
1876
These should only be downwards relative, not upwards.
1878
if relpath is not None and relpath != '.':
1879
if not base.endswith('/'):
1881
# XXX: Really base should be a url; we did after all call
1882
# get_url()! But sometimes it's just a path (from
1883
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1884
# to a non-escaped local path.
1885
if base.startswith('./') or base.startswith('/'):
1888
base += urlutils.escape(relpath)
1891
def get_url(self, relpath=None):
1892
"""Get a URL (or maybe a path) for the readwrite transport.
1894
This will either be backed by '.' or to an equivalent non-file based
1896
relpath provides for clients to get a path relative to the base url.
1897
These should only be downwards relative, not upwards.
1899
base = self.get_server().get_url()
1900
return self._adjust_url(base, relpath)
1902
def get_vfs_only_url(self, relpath=None):
1903
"""Get a URL (or maybe a path for the plain old vfs transport.
1905
This will never be a smart protocol. It always has all the
1906
capabilities of the local filesystem, but it might actually be a
1907
MemoryTransport or some other similar virtual filesystem.
1909
This is the backing transport (if any) of the server returned by
1910
get_url and get_readonly_url.
1912
:param relpath: provides for clients to get a path relative to the base
1913
url. These should only be downwards relative, not upwards.
1916
base = self.get_vfs_only_server().get_url()
1917
return self._adjust_url(base, relpath)
1919
def _create_safety_net(self):
1920
"""Make a fake bzr directory.
1922
This prevents any tests propagating up onto the TEST_ROOT directory's
1925
root = TestCaseWithMemoryTransport.TEST_ROOT
1926
bzrdir.BzrDir.create_standalone_workingtree(root)
1928
def _check_safety_net(self):
1929
"""Check that the safety .bzr directory have not been touched.
1931
_make_test_root have created a .bzr directory to prevent tests from
1932
propagating. This method ensures than a test did not leaked.
1934
root = TestCaseWithMemoryTransport.TEST_ROOT
1935
wt = workingtree.WorkingTree.open(root)
1936
last_rev = wt.last_revision()
1937
if last_rev != 'null:':
1938
# The current test have modified the /bzr directory, we need to
1939
# recreate a new one or all the followng tests will fail.
1940
# If you need to inspect its content uncomment the following line
1941
# import pdb; pdb.set_trace()
1942
_rmtree_temp_dir(root + '/.bzr')
1943
self._create_safety_net()
1944
raise AssertionError('%s/.bzr should not be modified' % root)
1946
def _make_test_root(self):
1947
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1948
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1949
TestCaseWithMemoryTransport.TEST_ROOT = root
1951
self._create_safety_net()
1953
# The same directory is used by all tests, and we're not
1954
# specifically told when all tests are finished. This will do.
1955
atexit.register(_rmtree_temp_dir, root)
1957
self.addCleanup(self._check_safety_net)
1959
def makeAndChdirToTestDir(self):
1960
"""Create a temporary directories for this one test.
1962
This must set self.test_home_dir and self.test_dir and chdir to
1965
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1967
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1968
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1969
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1971
def make_branch(self, relpath, format=None):
1972
"""Create a branch on the transport at relpath."""
1973
repo = self.make_repository(relpath, format=format)
1974
return repo.bzrdir.create_branch()
1976
def make_bzrdir(self, relpath, format=None):
1978
# might be a relative or absolute path
1979
maybe_a_url = self.get_url(relpath)
1980
segments = maybe_a_url.rsplit('/', 1)
1981
t = get_transport(maybe_a_url)
1982
if len(segments) > 1 and segments[-1] not in ('', '.'):
1986
if isinstance(format, basestring):
1987
format = bzrdir.format_registry.make_bzrdir(format)
1988
return format.initialize_on_transport(t)
1989
except errors.UninitializableFormat:
1990
raise TestSkipped("Format %s is not initializable." % format)
1992
def make_repository(self, relpath, shared=False, format=None):
1993
"""Create a repository on our default transport at relpath.
1995
Note that relpath must be a relative path, not a full url.
1997
# FIXME: If you create a remoterepository this returns the underlying
1998
# real format, which is incorrect. Actually we should make sure that
1999
# RemoteBzrDir returns a RemoteRepository.
2000
# maybe mbp 20070410
2001
made_control = self.make_bzrdir(relpath, format=format)
2002
return made_control.create_repository(shared=shared)
2004
def make_branch_and_memory_tree(self, relpath, format=None):
2005
"""Create a branch on the default transport and a MemoryTree for it."""
2006
b = self.make_branch(relpath, format=format)
2007
return memorytree.MemoryTree.create_on_branch(b)
2009
def overrideEnvironmentForTesting(self):
2010
os.environ['HOME'] = self.test_home_dir
2011
os.environ['BZR_HOME'] = self.test_home_dir
2014
super(TestCaseWithMemoryTransport, self).setUp()
2015
self._make_test_root()
2016
_currentdir = os.getcwdu()
2017
def _leaveDirectory():
2018
os.chdir(_currentdir)
2019
self.addCleanup(_leaveDirectory)
2020
self.makeAndChdirToTestDir()
2021
self.overrideEnvironmentForTesting()
2022
self.__readonly_server = None
2023
self.__server = None
2024
self.reduceLockdirTimeout()
163
class TestCaseInTempDir(TestCase):
2027
class TestCaseInTempDir(TestCaseWithMemoryTransport):
164
2028
"""Derived class that runs a test within a temporary directory.
166
2030
This is useful for tests that need to create a branch, etc.
183
2052
if contents != expect:
184
2053
self.log("expected: %r" % expect)
185
2054
self.log("actually: %r" % contents)
186
self.fail("contents of %s not as expected")
188
def _make_test_root(self):
189
if TestCaseInTempDir.TEST_ROOT is not None:
193
root = 'test%04d.tmp' % i
197
if e.errno == errno.EEXIST:
202
# successfully created
203
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
205
# make a fake bzr directory there to prevent any tests propagating
206
# up onto the source directory's real branch
207
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
210
super(TestCaseInTempDir, self).setUp()
212
self._make_test_root()
213
self._currentdir = os.getcwdu()
214
short_id = self.id().replace('bzrlib.selftest.', '') \
215
.replace('__main__.', '')
216
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
2055
self.fail("contents of %s not as expected" % filename)
2057
def makeAndChdirToTestDir(self):
2058
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2060
For TestCaseInTempDir we create a temporary directory based on the test
2061
name and then create two subdirs - test and home under it.
2063
# create a directory within the top level test directory
2064
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2065
# now create test and home directories within this dir
2066
self.test_base_dir = candidate_dir
2067
self.test_home_dir = self.test_base_dir + '/home'
2068
os.mkdir(self.test_home_dir)
2069
self.test_dir = self.test_base_dir + '/work'
217
2070
os.mkdir(self.test_dir)
218
2071
os.chdir(self.test_dir)
222
os.chdir(self._currentdir)
223
super(TestCaseInTempDir, self).tearDown()
225
def _formcmd(self, cmd):
226
if isinstance(cmd, basestring):
229
cmd[0] = self.BZRPATH
230
if self.OVERRIDE_PYTHON:
231
cmd.insert(0, self.OVERRIDE_PYTHON)
232
self.log('$ %r' % cmd)
235
def runcmd(self, cmd, retcode=0):
236
"""Run one command and check the return code.
238
Returns a tuple of (stdout,stderr) strings.
240
If a single string is based, it is split into words.
241
For commands that are not simple space-separated words, please
242
pass a list instead."""
243
cmd = self._formcmd(cmd)
244
self.log('$ ' + ' '.join(cmd))
245
actual_retcode = subprocess.call(cmd, stdout=self._log_file,
246
stderr=self._log_file)
247
if retcode != actual_retcode:
248
raise CommandFailed("test failed: %r returned %d, expected %d"
249
% (cmd, actual_retcode, retcode))
251
def backtick(self, cmd, retcode=0):
252
"""Run a command and return its output"""
253
cmd = self._formcmd(cmd)
254
child = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self._log_file)
255
outd, errd = child.communicate()
257
actual_retcode = child.wait()
259
outd = outd.replace('\r', '')
261
if retcode != actual_retcode:
262
raise CommandFailed("test failed: %r returned %d, expected %d"
263
% (cmd, actual_retcode, retcode))
269
def build_tree(self, shape):
2072
# put name of test inside
2073
f = file(self.test_base_dir + '/name', 'w')
2078
self.addCleanup(self.deleteTestDir)
2080
def deleteTestDir(self):
2081
os.chdir(self.TEST_ROOT)
2082
_rmtree_temp_dir(self.test_base_dir)
2084
def build_tree(self, shape, line_endings='binary', transport=None):
270
2085
"""Build a test tree according to a pattern.
272
2087
shape is a sequence of file specifications. If the final
273
2088
character is '/', a directory is created.
2090
This assumes that all the elements in the tree being built are new.
275
2092
This doesn't add anything to a branch.
2094
:type shape: list or tuple.
2095
:param line_endings: Either 'binary' or 'native'
2096
in binary mode, exact contents are written in native mode, the
2097
line endings match the default platform endings.
2098
:param transport: A transport to write to, for building trees on VFS's.
2099
If the transport is readonly or None, "." is opened automatically.
277
# XXX: It's OK to just create them using forward slashes on windows?
2102
if type(shape) not in (list, tuple):
2103
raise AssertionError("Parameter 'shape' should be "
2104
"a list or a tuple. Got %r instead" % (shape,))
2105
# It's OK to just create them using forward slashes on windows.
2106
if transport is None or transport.is_readonly():
2107
transport = get_transport(".")
279
2108
for name in shape:
280
assert isinstance(name, basestring)
2109
self.assert_(isinstance(name, basestring))
281
2110
if name[-1] == '/':
285
print >>f, "contents of", name
290
class MetaTestLog(TestCase):
291
def test_logging(self):
292
"""Test logs are captured when a test fails."""
293
logging.info('an info message')
294
warning('something looks dodgy...')
295
logging.debug('hello, test is running')
299
def selftest(verbose=False, pattern=".*"):
2111
transport.mkdir(urlutils.escape(name[:-1]))
2113
if line_endings == 'binary':
2115
elif line_endings == 'native':
2118
raise errors.BzrError(
2119
'Invalid line ending request %r' % line_endings)
2120
content = "contents of %s%s" % (name.encode('utf-8'), end)
2121
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2123
def build_tree_contents(self, shape):
2124
build_tree_contents(shape)
2126
def assertInWorkingTree(self, path, root_path='.', tree=None):
2127
"""Assert whether path or paths are in the WorkingTree"""
2129
tree = workingtree.WorkingTree.open(root_path)
2130
if not isinstance(path, basestring):
2132
self.assertInWorkingTree(p,tree=tree)
2134
self.assertIsNot(tree.path2id(path), None,
2135
path+' not in working tree.')
2137
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2138
"""Assert whether path or paths are not in the WorkingTree"""
2140
tree = workingtree.WorkingTree.open(root_path)
2141
if not isinstance(path, basestring):
2143
self.assertNotInWorkingTree(p,tree=tree)
2145
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2148
class TestCaseWithTransport(TestCaseInTempDir):
2149
"""A test case that provides get_url and get_readonly_url facilities.
2151
These back onto two transport servers, one for readonly access and one for
2154
If no explicit class is provided for readonly access, a
2155
ReadonlyTransportDecorator is used instead which allows the use of non disk
2156
based read write transports.
2158
If an explicit class is provided for readonly access, that server and the
2159
readwrite one must both define get_url() as resolving to os.getcwd().
2162
def get_vfs_only_server(self):
2163
"""See TestCaseWithMemoryTransport.
2165
This is useful for some tests with specific servers that need
2168
if self.__vfs_server is None:
2169
self.__vfs_server = self.vfs_transport_factory()
2170
self.__vfs_server.setUp()
2171
self.addCleanup(self.__vfs_server.tearDown)
2172
return self.__vfs_server
2174
def make_branch_and_tree(self, relpath, format=None):
2175
"""Create a branch on the transport and a tree locally.
2177
If the transport is not a LocalTransport, the Tree can't be created on
2178
the transport. In that case if the vfs_transport_factory is
2179
LocalURLServer the working tree is created in the local
2180
directory backing the transport, and the returned tree's branch and
2181
repository will also be accessed locally. Otherwise a lightweight
2182
checkout is created and returned.
2184
:param format: The BzrDirFormat.
2185
:returns: the WorkingTree.
2187
# TODO: always use the local disk path for the working tree,
2188
# this obviously requires a format that supports branch references
2189
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2191
b = self.make_branch(relpath, format=format)
2193
return b.bzrdir.create_workingtree()
2194
except errors.NotLocalUrl:
2195
# We can only make working trees locally at the moment. If the
2196
# transport can't support them, then we keep the non-disk-backed
2197
# branch and create a local checkout.
2198
if self.vfs_transport_factory is LocalURLServer:
2199
# the branch is colocated on disk, we cannot create a checkout.
2200
# hopefully callers will expect this.
2201
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2202
return local_controldir.create_workingtree()
2204
return b.create_checkout(relpath, lightweight=True)
2206
def assertIsDirectory(self, relpath, transport):
2207
"""Assert that relpath within transport is a directory.
2209
This may not be possible on all transports; in that case it propagates
2210
a TransportNotPossible.
2213
mode = transport.stat(relpath).st_mode
2214
except errors.NoSuchFile:
2215
self.fail("path %s is not a directory; no such file"
2217
if not stat.S_ISDIR(mode):
2218
self.fail("path %s is not a directory; has mode %#o"
2221
def assertTreesEqual(self, left, right):
2222
"""Check that left and right have the same content and properties."""
2223
# we use a tree delta to check for equality of the content, and we
2224
# manually check for equality of other things such as the parents list.
2225
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2226
differences = left.changes_from(right)
2227
self.assertFalse(differences.has_changed(),
2228
"Trees %r and %r are different: %r" % (left, right, differences))
2231
super(TestCaseWithTransport, self).setUp()
2232
self.__vfs_server = None
2235
class ChrootedTestCase(TestCaseWithTransport):
2236
"""A support class that provides readonly urls outside the local namespace.
2238
This is done by checking if self.transport_server is a MemoryServer. if it
2239
is then we are chrooted already, if it is not then an HttpServer is used
2242
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2243
be used without needed to redo it when a different
2244
subclass is in use ?
2248
super(ChrootedTestCase, self).setUp()
2249
if not self.vfs_transport_factory == MemoryServer:
2250
self.transport_readonly_server = HttpServer
2253
def condition_id_re(pattern):
2254
"""Create a condition filter which performs a re check on a test's id.
2256
:param pattern: A regular expression string.
2257
:return: A callable that returns True if the re matches.
2259
filter_re = re.compile(pattern)
2260
def condition(test):
2262
return filter_re.search(test_id)
2266
def condition_isinstance(klass_or_klass_list):
2267
"""Create a condition filter which returns isinstance(param, klass).
2269
:return: A callable which when called with one parameter obj return the
2270
result of isinstance(obj, klass_or_klass_list).
2273
return isinstance(obj, klass_or_klass_list)
2277
def condition_id_in_list(id_list):
2278
"""Create a condition filter which verify that test's id in a list.
2280
:param id_list: A TestIdList object.
2281
:return: A callable that returns True if the test's id appears in the list.
2283
def condition(test):
2284
return id_list.includes(test.id())
2288
def exclude_tests_by_condition(suite, condition):
2289
"""Create a test suite which excludes some tests from suite.
2291
:param suite: The suite to get tests from.
2292
:param condition: A callable whose result evaluates True when called with a
2293
test case which should be excluded from the result.
2294
:return: A suite which contains the tests found in suite that fail
2298
for test in iter_suite_tests(suite):
2299
if not condition(test):
2301
return TestUtil.TestSuite(result)
2304
def filter_suite_by_condition(suite, condition):
2305
"""Create a test suite by filtering another one.
2307
:param suite: The source suite.
2308
:param condition: A callable whose result evaluates True when called with a
2309
test case which should be included in the result.
2310
:return: A suite which contains the tests found in suite that pass
2314
for test in iter_suite_tests(suite):
2317
return TestUtil.TestSuite(result)
2320
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2321
random_order=DEPRECATED_PARAMETER):
2322
"""Create a test suite by filtering another one.
2324
:param suite: the source suite
2325
:param pattern: pattern that names must match
2326
:param exclude_pattern: A pattern that names must not match. This parameter
2327
is deprecated as of bzrlib 1.0. Please use the separate function
2328
exclude_tests_by_re instead.
2329
:param random_order: If True, tests in the new suite will be put in
2330
random order. This parameter is deprecated as of bzrlib 1.0. Please
2331
use the separate function randomize_suite instead.
2332
:returns: the newly created suite
2334
if deprecated_passed(exclude_pattern):
2335
symbol_versioning.warn(
2336
one_zero % "passing exclude_pattern to filter_suite_by_re",
2337
DeprecationWarning, stacklevel=2)
2338
if exclude_pattern is not None:
2339
suite = exclude_tests_by_re(suite, exclude_pattern)
2340
condition = condition_id_re(pattern)
2341
result_suite = filter_suite_by_condition(suite, condition)
2342
if deprecated_passed(random_order):
2343
symbol_versioning.warn(
2344
one_zero % "passing random_order to filter_suite_by_re",
2345
DeprecationWarning, stacklevel=2)
2347
result_suite = randomize_suite(result_suite)
2351
def filter_suite_by_id_list(suite, test_id_list):
2352
"""Create a test suite by filtering another one.
2354
:param suite: The source suite.
2355
:param test_id_list: A list of the test ids to keep as strings.
2356
:returns: the newly created suite
2358
condition = condition_id_in_list(test_id_list)
2359
result_suite = filter_suite_by_condition(suite, condition)
2363
def exclude_tests_by_re(suite, pattern):
2364
"""Create a test suite which excludes some tests from suite.
2366
:param suite: The suite to get tests from.
2367
:param pattern: A regular expression string. Test ids that match this
2368
pattern will be excluded from the result.
2369
:return: A TestSuite that contains all the tests from suite without the
2370
tests that matched pattern. The order of tests is the same as it was in
2373
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2376
def preserve_input(something):
2377
"""A helper for performing test suite transformation chains.
2379
:param something: Anything you want to preserve.
2385
def randomize_suite(suite):
2386
"""Return a new TestSuite with suite's tests in random order.
2388
The tests in the input suite are flattened into a single suite in order to
2389
accomplish this. Any nested TestSuites are removed to provide global
2392
tests = list(iter_suite_tests(suite))
2393
random.shuffle(tests)
2394
return TestUtil.TestSuite(tests)
2397
@deprecated_function(one_zero)
2398
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2399
random_order=False, append_rest=True):
2400
"""DEPRECATED: Create a test suite by sorting another one.
2402
This method has been decomposed into separate helper methods that should be
2404
- filter_suite_by_re
2405
- exclude_tests_by_re
2409
:param suite: the source suite
2410
:param pattern: pattern that names must match in order to go
2411
first in the new suite
2412
:param exclude_pattern: pattern that names must not match, if any
2413
:param random_order: if True, tests in the new suite will be put in
2414
random order (with all tests matching pattern
2416
:param append_rest: if False, pattern is a strict filter and not
2417
just an ordering directive
2418
:returns: the newly created suite
2420
if exclude_pattern is not None:
2421
suite = exclude_tests_by_re(suite, exclude_pattern)
2423
order_changer = randomize_suite
2425
order_changer = preserve_input
2427
suites = map(order_changer, split_suite_by_re(suite, pattern))
2428
return TestUtil.TestSuite(suites)
2430
return order_changer(filter_suite_by_re(suite, pattern))
2433
def split_suite_by_re(suite, pattern):
2434
"""Split a test suite into two by a regular expression.
2436
:param suite: The suite to split.
2437
:param pattern: A regular expression string. Test ids that match this
2438
pattern will be in the first test suite returned, and the others in the
2439
second test suite returned.
2440
:return: A tuple of two test suites, where the first contains tests from
2441
suite matching pattern, and the second contains the remainder from
2442
suite. The order within each output suite is the same as it was in
2447
filter_re = re.compile(pattern)
2448
for test in iter_suite_tests(suite):
2450
if filter_re.search(test_id):
2451
matched.append(test)
2453
did_not_match.append(test)
2454
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2457
def run_suite(suite, name='test', verbose=False, pattern=".*",
2458
stop_on_failure=False,
2459
transport=None, lsprof_timed=None, bench_history=None,
2460
matching_tests_first=None,
2463
exclude_pattern=None,
2465
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2470
runner = TextTestRunner(stream=sys.stdout,
2472
verbosity=verbosity,
2473
bench_history=bench_history,
2474
list_only=list_only,
2476
runner.stop_on_failure=stop_on_failure
2477
# Initialise the random number generator and display the seed used.
2478
# We convert the seed to a long to make it reuseable across invocations.
2479
random_order = False
2480
if random_seed is not None:
2482
if random_seed == "now":
2483
random_seed = long(time.time())
2485
# Convert the seed to a long if we can
2487
random_seed = long(random_seed)
2490
runner.stream.writeln("Randomizing test order using seed %s\n" %
2492
random.seed(random_seed)
2493
# Customise the list of tests if requested
2494
if exclude_pattern is not None:
2495
suite = exclude_tests_by_re(suite, exclude_pattern)
2497
order_changer = randomize_suite
2499
order_changer = preserve_input
2500
if pattern != '.*' or random_order:
2501
if matching_tests_first:
2502
suites = map(order_changer, split_suite_by_re(suite, pattern))
2503
suite = TestUtil.TestSuite(suites)
2505
suite = order_changer(filter_suite_by_re(suite, pattern))
2507
result = runner.run(suite)
2510
return result.wasStrictlySuccessful()
2512
return result.wasSuccessful()
2515
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2517
test_suite_factory=None,
2520
matching_tests_first=None,
2523
exclude_pattern=None,
300
2527
"""Run the whole test suite under the enhanced runner"""
301
return testsweet.run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern)
305
"""Build and return TestSuite for the whole program."""
306
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
307
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
308
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
309
from doctest import DocTestSuite
315
global MODULES_TO_TEST, MODULES_TO_DOCTEST
318
['bzrlib.selftest.MetaTestLog',
319
'bzrlib.selftest.testinv',
320
'bzrlib.selftest.versioning',
321
'bzrlib.selftest.testmerge3',
322
'bzrlib.selftest.testhashcache',
323
'bzrlib.selftest.teststatus',
324
'bzrlib.selftest.testlog',
325
'bzrlib.selftest.testrevisionnamespaces',
326
'bzrlib.selftest.testbranch',
327
# 'bzrlib.selftest.testrevision',
328
# 'bzrlib.selftest.test_merge_core',
329
'bzrlib.selftest.test_smart_add',
330
'bzrlib.selftest.testdiff',
331
# 'bzrlib.selftest.test_parent',
332
'bzrlib.selftest.test_xml',
333
# 'bzrlib.selftest.testfetch',
334
# 'bzrlib.selftest.whitebox',
335
'bzrlib.selftest.teststore',
336
# 'bzrlib.selftest.blackbox',
2528
# XXX: Very ugly way to do this...
2529
# Disable warning about old formats because we don't want it to disturb
2530
# any blackbox tests.
2531
from bzrlib import repository
2532
repository._deprecation_warning_done = True
2534
global default_transport
2535
if transport is None:
2536
transport = default_transport
2537
old_transport = default_transport
2538
default_transport = transport
2540
if load_list is None:
2543
keep_only = load_test_id_list(load_list)
2544
if test_suite_factory is None:
2545
suite = test_suite(keep_only)
2547
suite = test_suite_factory()
2548
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2549
stop_on_failure=stop_on_failure,
2550
transport=transport,
2551
lsprof_timed=lsprof_timed,
2552
bench_history=bench_history,
2553
matching_tests_first=matching_tests_first,
2554
list_only=list_only,
2555
random_seed=random_seed,
2556
exclude_pattern=exclude_pattern,
2559
default_transport = old_transport
2562
def load_test_id_list(file_name):
2563
"""Load a test id list from a text file.
2565
The format is one test id by line. No special care is taken to impose
2566
strict rules, these test ids are used to filter the test suite so a test id
2567
that do not match an existing test will do no harm. This allows user to add
2568
comments, leave blank lines, etc.
2572
ftest = open(file_name, 'rt')
2574
if e.errno != errno.ENOENT:
2577
raise errors.NoSuchFile(file_name)
2579
for test_name in ftest.readlines():
2580
test_list.append(test_name.strip())
2585
def suite_matches_id_list(test_suite, id_list):
2586
"""Warns about tests not appearing or appearing more than once.
2588
:param test_suite: A TestSuite object.
2589
:param test_id_list: The list of test ids that should be found in
2592
:return: (absents, duplicates) absents is a list containing the test found
2593
in id_list but not in test_suite, duplicates is a list containing the
2594
test found multiple times in test_suite.
2596
When using a prefined test id list, it may occurs that some tests do not
2597
exist anymore or that some tests use the same id. This function warns the
2598
tester about potential problems in his workflow (test lists are volatile)
2599
or in the test suite itself (using the same id for several tests does not
2600
help to localize defects).
2602
# Build a dict counting id occurrences
2604
for test in iter_suite_tests(test_suite):
2606
tests[id] = tests.get(id, 0) + 1
2611
occurs = tests.get(id, 0)
2613
not_found.append(id)
2615
duplicates.append(id)
2617
return not_found, duplicates
2620
class TestIdList(object):
2621
"""Test id list to filter a test suite.
2623
Relying on the assumption that test ids are built as:
2624
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2625
notation, this class offers methods to :
2626
- avoid building a test suite for modules not refered to in the test list,
2627
- keep only the tests listed from the module test suite.
2630
def __init__(self, test_id_list):
2631
# When a test suite needs to be filtered against us we compare test ids
2632
# for equality, so a simple dict offers a quick and simple solution.
2633
self.tests = dict().fromkeys(test_id_list, True)
2635
# While unittest.TestCase have ids like:
2636
# <module>.<class>.<method>[(<param+)],
2637
# doctest.DocTestCase can have ids like:
2640
# <module>.<function>
2641
# <module>.<class>.<method>
2643
# Since we can't predict a test class from its name only, we settle on
2644
# a simple constraint: a test id always begins with its module name.
2647
for test_id in test_id_list:
2648
parts = test_id.split('.')
2649
mod_name = parts.pop(0)
2650
modules[mod_name] = True
2652
mod_name += '.' + part
2653
modules[mod_name] = True
2654
self.modules = modules
2656
def refers_to(self, module_name):
2657
"""Is there tests for the module or one of its sub modules."""
2658
return self.modules.has_key(module_name)
2660
def includes(self, test_id):
2661
return self.tests.has_key(test_id)
2664
def test_suite(keep_only=None):
2665
"""Build and return TestSuite for the whole of bzrlib.
2667
:param keep_only: A list of test ids limiting the suite returned.
2669
This function can be replaced if you need to change the default test
2670
suite on a global basis, but it is not encouraged.
2673
'bzrlib.util.tests.test_bencode',
2674
'bzrlib.tests.test__dirstate_helpers',
2675
'bzrlib.tests.test_ancestry',
2676
'bzrlib.tests.test_annotate',
2677
'bzrlib.tests.test_api',
2678
'bzrlib.tests.test_atomicfile',
2679
'bzrlib.tests.test_bad_files',
2680
'bzrlib.tests.test_bisect_multi',
2681
'bzrlib.tests.test_branch',
2682
'bzrlib.tests.test_branchbuilder',
2683
'bzrlib.tests.test_bugtracker',
2684
'bzrlib.tests.test_bundle',
2685
'bzrlib.tests.test_bzrdir',
2686
'bzrlib.tests.test_cache_utf8',
2687
'bzrlib.tests.test_commands',
2688
'bzrlib.tests.test_commit',
2689
'bzrlib.tests.test_commit_merge',
2690
'bzrlib.tests.test_config',
2691
'bzrlib.tests.test_conflicts',
2692
'bzrlib.tests.test_counted_lock',
2693
'bzrlib.tests.test_decorators',
2694
'bzrlib.tests.test_delta',
2695
'bzrlib.tests.test_deprecated_graph',
2696
'bzrlib.tests.test_diff',
2697
'bzrlib.tests.test_dirstate',
2698
'bzrlib.tests.test_directory_service',
2699
'bzrlib.tests.test_email_message',
2700
'bzrlib.tests.test_errors',
2701
'bzrlib.tests.test_escaped_store',
2702
'bzrlib.tests.test_extract',
2703
'bzrlib.tests.test_fetch',
2704
'bzrlib.tests.test_ftp_transport',
2705
'bzrlib.tests.test_generate_docs',
2706
'bzrlib.tests.test_generate_ids',
2707
'bzrlib.tests.test_globbing',
2708
'bzrlib.tests.test_gpg',
2709
'bzrlib.tests.test_graph',
2710
'bzrlib.tests.test_hashcache',
2711
'bzrlib.tests.test_help',
2712
'bzrlib.tests.test_hooks',
2713
'bzrlib.tests.test_http',
2714
'bzrlib.tests.test_http_implementations',
2715
'bzrlib.tests.test_http_response',
2716
'bzrlib.tests.test_https_ca_bundle',
2717
'bzrlib.tests.test_identitymap',
2718
'bzrlib.tests.test_ignores',
2719
'bzrlib.tests.test_index',
2720
'bzrlib.tests.test_info',
2721
'bzrlib.tests.test_inv',
2722
'bzrlib.tests.test_knit',
2723
'bzrlib.tests.test_lazy_import',
2724
'bzrlib.tests.test_lazy_regex',
2725
'bzrlib.tests.test_lockdir',
2726
'bzrlib.tests.test_lockable_files',
2727
'bzrlib.tests.test_log',
2728
'bzrlib.tests.test_lsprof',
2729
'bzrlib.tests.test_lru_cache',
2730
'bzrlib.tests.test_mail_client',
2731
'bzrlib.tests.test_memorytree',
2732
'bzrlib.tests.test_merge',
2733
'bzrlib.tests.test_merge3',
2734
'bzrlib.tests.test_merge_core',
2735
'bzrlib.tests.test_merge_directive',
2736
'bzrlib.tests.test_missing',
2737
'bzrlib.tests.test_msgeditor',
2738
'bzrlib.tests.test_multiparent',
2739
'bzrlib.tests.test_mutabletree',
2740
'bzrlib.tests.test_nonascii',
2741
'bzrlib.tests.test_options',
2742
'bzrlib.tests.test_osutils',
2743
'bzrlib.tests.test_osutils_encodings',
2744
'bzrlib.tests.test_pack',
2745
'bzrlib.tests.test_patch',
2746
'bzrlib.tests.test_patches',
2747
'bzrlib.tests.test_permissions',
2748
'bzrlib.tests.test_plugins',
2749
'bzrlib.tests.test_progress',
2750
'bzrlib.tests.test_reconfigure',
2751
'bzrlib.tests.test_reconcile',
2752
'bzrlib.tests.test_registry',
2753
'bzrlib.tests.test_remote',
2754
'bzrlib.tests.test_repository',
2755
'bzrlib.tests.test_revert',
2756
'bzrlib.tests.test_revision',
2757
'bzrlib.tests.test_revisionspec',
2758
'bzrlib.tests.test_revisiontree',
2759
'bzrlib.tests.test_rio',
2760
'bzrlib.tests.test_sampler',
2761
'bzrlib.tests.test_selftest',
2762
'bzrlib.tests.test_setup',
2763
'bzrlib.tests.test_sftp_transport',
2764
'bzrlib.tests.test_smart',
2765
'bzrlib.tests.test_smart_add',
2766
'bzrlib.tests.test_smart_transport',
2767
'bzrlib.tests.test_smtp_connection',
2768
'bzrlib.tests.test_source',
2769
'bzrlib.tests.test_ssh_transport',
2770
'bzrlib.tests.test_status',
2771
'bzrlib.tests.test_store',
2772
'bzrlib.tests.test_strace',
2773
'bzrlib.tests.test_subsume',
2774
'bzrlib.tests.test_switch',
2775
'bzrlib.tests.test_symbol_versioning',
2776
'bzrlib.tests.test_tag',
2777
'bzrlib.tests.test_testament',
2778
'bzrlib.tests.test_textfile',
2779
'bzrlib.tests.test_textmerge',
2780
'bzrlib.tests.test_timestamp',
2781
'bzrlib.tests.test_trace',
2782
'bzrlib.tests.test_transactions',
2783
'bzrlib.tests.test_transform',
2784
'bzrlib.tests.test_transport',
2785
'bzrlib.tests.test_tree',
2786
'bzrlib.tests.test_treebuilder',
2787
'bzrlib.tests.test_tsort',
2788
'bzrlib.tests.test_tuned_gzip',
2789
'bzrlib.tests.test_ui',
2790
'bzrlib.tests.test_uncommit',
2791
'bzrlib.tests.test_upgrade',
2792
'bzrlib.tests.test_urlutils',
2793
'bzrlib.tests.test_versionedfile',
2794
'bzrlib.tests.test_version',
2795
'bzrlib.tests.test_version_info',
2796
'bzrlib.tests.test_weave',
2797
'bzrlib.tests.test_whitebox',
2798
'bzrlib.tests.test_win32utils',
2799
'bzrlib.tests.test_workingtree',
2800
'bzrlib.tests.test_workingtree_4',
2801
'bzrlib.tests.test_wsgi',
2802
'bzrlib.tests.test_xml',
339
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
340
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
341
if m not in MODULES_TO_DOCTEST:
342
MODULES_TO_DOCTEST.append(m)
344
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
345
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
348
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
349
for m in MODULES_TO_TEST:
350
suite.addTest(TestLoader().loadTestsFromModule(m))
351
for m in (MODULES_TO_DOCTEST):
352
suite.addTest(DocTestSuite(m))
353
for p in bzrlib.plugin.all_plugins:
354
if hasattr(p, 'test_suite'):
355
suite.addTest(p.test_suite())
2804
test_transport_implementations = [
2805
'bzrlib.tests.test_transport_implementations',
2806
'bzrlib.tests.test_read_bundle',
2808
loader = TestUtil.TestLoader()
2810
if keep_only is None:
2811
loader = TestUtil.TestLoader()
2813
id_filter = TestIdList(keep_only)
2814
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2815
suite = loader.suiteClass()
2817
# modules building their suite with loadTestsFromModuleNames
2818
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2820
# modules adapted for transport implementations
2821
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2822
adapter = TransportTestProviderAdapter()
2823
adapt_modules(test_transport_implementations, adapter, loader, suite)
2825
# modules defining their own test_suite()
2826
for package in [p for p in packages_to_test()
2827
if (keep_only is None
2828
or id_filter.refers_to(p.__name__))]:
2829
pack_suite = package.test_suite()
2830
suite.addTest(pack_suite)
2832
modules_to_doctest = [
2837
'bzrlib.iterablefile',
2844
'bzrlib.version_info_formats.format_custom',
2847
for mod in modules_to_doctest:
2848
if not (keep_only is None or id_filter.refers_to(mod)):
2849
# No tests to keep here, move along
2852
doc_suite = doctest.DocTestSuite(mod)
2853
except ValueError, e:
2854
print '**failed to get doctest for: %s\n%s' % (mod, e)
2856
suite.addTest(doc_suite)
2858
default_encoding = sys.getdefaultencoding()
2859
for name, plugin in bzrlib.plugin.plugins().items():
2860
if keep_only is not None:
2861
if not id_filter.refers_to(plugin.module.__name__):
2863
plugin_suite = plugin.test_suite()
2864
# We used to catch ImportError here and turn it into just a warning,
2865
# but really if you don't have --no-plugins this should be a failure.
2866
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2867
if plugin_suite is None:
2868
plugin_suite = plugin.load_plugin_tests(loader)
2869
if plugin_suite is not None:
2870
suite.addTest(plugin_suite)
2871
if default_encoding != sys.getdefaultencoding():
2872
bzrlib.trace.warning(
2873
'Plugin "%s" tried to reset default encoding to: %s', name,
2874
sys.getdefaultencoding())
2876
sys.setdefaultencoding(default_encoding)
2878
if keep_only is not None:
2879
# Now that the referred modules have loaded their tests, keep only the
2881
suite = filter_suite_by_id_list(suite, id_filter)
2882
# Do some sanity checks on the id_list filtering
2883
not_found, duplicates = suite_matches_id_list(suite, keep_only)
2884
for id in not_found:
2885
bzrlib.trace.warning('"%s" not found in the test suite', id)
2886
for id in duplicates:
2887
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2892
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2893
"""Adapt all tests in some given modules to given scenarios.
2895
This is the recommended public interface for test parameterization.
2896
Typically the test_suite() method for a per-implementation test
2897
suite will call multiply_tests_from_modules and return the
2900
:param module_name_list: List of fully-qualified names of test
2902
:param scenario_iter: Iterable of pairs of (scenario_name,
2903
scenario_param_dict).
2904
:param loader: If provided, will be used instead of a new
2905
bzrlib.tests.TestLoader() instance.
2907
This returns a new TestSuite containing the cross product of
2908
all the tests in all the modules, each repeated for each scenario.
2909
Each test is adapted by adding the scenario name at the end
2910
of its name, and updating the test object's __dict__ with the
2911
scenario_param_dict.
2913
>>> r = multiply_tests_from_modules(
2914
... ['bzrlib.tests.test_sampler'],
2915
... [('one', dict(param=1)),
2916
... ('two', dict(param=2))])
2917
>>> tests = list(iter_suite_tests(r))
2921
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2927
# XXX: Isn't load_tests() a better way to provide the same functionality
2928
# without forcing a predefined TestScenarioApplier ? --vila 080215
2930
loader = TestUtil.TestLoader()
2932
suite = loader.suiteClass()
2934
adapter = TestScenarioApplier()
2935
adapter.scenarios = list(scenario_iter)
2936
adapt_modules(module_name_list, adapter, loader, suite)
2940
def multiply_scenarios(scenarios_left, scenarios_right):
2941
"""Multiply two sets of scenarios.
2943
:returns: the cartesian product of the two sets of scenarios, that is
2944
a scenario for every possible combination of a left scenario and a
2948
('%s,%s' % (left_name, right_name),
2949
dict(left_dict.items() + right_dict.items()))
2950
for left_name, left_dict in scenarios_left
2951
for right_name, right_dict in scenarios_right]
2955
def adapt_modules(mods_list, adapter, loader, suite):
2956
"""Adapt the modules in mods_list using adapter and add to suite."""
2957
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2958
suite.addTests(adapter.adapt(test))
2961
def adapt_tests(tests_list, adapter, loader, suite):
2962
"""Adapt the tests in tests_list using adapter and add to suite."""
2963
for test in tests_list:
2964
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2967
def _rmtree_temp_dir(dirname):
2968
# If LANG=C we probably have created some bogus paths
2969
# which rmtree(unicode) will fail to delete
2970
# so make sure we are using rmtree(str) to delete everything
2971
# except on win32, where rmtree(str) will fail
2972
# since it doesn't have the property of byte-stream paths
2973
# (they are either ascii or mbcs)
2974
if sys.platform == 'win32':
2975
# make sure we are using the unicode win32 api
2976
dirname = unicode(dirname)
2978
dirname = dirname.encode(sys.getfilesystemencoding())
2980
osutils.rmtree(dirname)
2982
if sys.platform == 'win32' and e.errno == errno.EACCES:
2983
sys.stderr.write(('Permission denied: '
2984
'unable to remove testing dir '
2985
'%s\n' % os.path.basename(dirname)))
2990
class Feature(object):
2991
"""An operating system Feature."""
2994
self._available = None
2996
def available(self):
2997
"""Is the feature available?
2999
:return: True if the feature is available.
3001
if self._available is None:
3002
self._available = self._probe()
3003
return self._available
3006
"""Implement this method in concrete features.
3008
:return: True if the feature is available.
3010
raise NotImplementedError
3013
if getattr(self, 'feature_name', None):
3014
return self.feature_name()
3015
return self.__class__.__name__
3018
class _SymlinkFeature(Feature):
3021
return osutils.has_symlinks()
3023
def feature_name(self):
3026
SymlinkFeature = _SymlinkFeature()
3029
class _HardlinkFeature(Feature):
3032
return osutils.has_hardlinks()
3034
def feature_name(self):
3037
HardlinkFeature = _HardlinkFeature()
3040
class _OsFifoFeature(Feature):
3043
return getattr(os, 'mkfifo', None)
3045
def feature_name(self):
3046
return 'filesystem fifos'
3048
OsFifoFeature = _OsFifoFeature()
3051
class TestScenarioApplier(object):
3052
"""A tool to apply scenarios to tests."""
3054
def adapt(self, test):
3055
"""Return a TestSuite containing a copy of test for each scenario."""
3056
result = unittest.TestSuite()
3057
for scenario in self.scenarios:
3058
result.addTest(self.adapt_test_to_scenario(test, scenario))
3061
def adapt_test_to_scenario(self, test, scenario):
3062
"""Copy test and apply scenario to it.
3064
:param test: A test to adapt.
3065
:param scenario: A tuple describing the scenarion.
3066
The first element of the tuple is the new test id.
3067
The second element is a dict containing attributes to set on the
3069
:return: The adapted test.
3071
from copy import deepcopy
3072
new_test = deepcopy(test)
3073
for name, value in scenario[1].items():
3074
setattr(new_test, name, value)
3075
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3076
new_test.id = lambda: new_id
3080
def probe_unicode_in_user_encoding():
3081
"""Try to encode several unicode strings to use in unicode-aware tests.
3082
Return first successfull match.
3084
:return: (unicode value, encoded plain string value) or (None, None)
3086
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3087
for uni_val in possible_vals:
3089
str_val = uni_val.encode(bzrlib.user_encoding)
3090
except UnicodeEncodeError:
3091
# Try a different character
3094
return uni_val, str_val
3098
def probe_bad_non_ascii(encoding):
3099
"""Try to find [bad] character with code [128..255]
3100
that cannot be decoded to unicode in some encoding.
3101
Return None if all non-ascii characters is valid
3104
for i in xrange(128, 256):
3107
char.decode(encoding)
3108
except UnicodeDecodeError:
3113
class _FTPServerFeature(Feature):
3114
"""Some tests want an FTP Server, check if one is available.
3116
Right now, the only way this is available is if 'medusa' is installed.
3117
http://www.amk.ca/python/code/medusa.html
3122
import bzrlib.tests.ftp_server
3127
def feature_name(self):
3130
FTPServerFeature = _FTPServerFeature()
3133
class _CaseInsensitiveFilesystemFeature(Feature):
3134
"""Check if underlined filesystem is case-insensitive
3135
(e.g. on Windows, Cygwin, MacOS)
3139
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3140
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3141
TestCaseWithMemoryTransport.TEST_ROOT = root
3143
root = TestCaseWithMemoryTransport.TEST_ROOT
3144
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3146
name_a = osutils.pathjoin(tdir, 'a')
3147
name_A = osutils.pathjoin(tdir, 'A')
3149
result = osutils.isdir(name_A)
3150
_rmtree_temp_dir(tdir)
3153
def feature_name(self):
3154
return 'case-insensitive filesystem'
3156
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
