56
56
# nb: check this before importing anything else from within it
57
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 2):
59
raise ImportError("need at least testtools 0.9.2: %s is %r"
58
if _testtools_version < (0, 9, 5):
59
raise ImportError("need at least testtools 0.9.5: %s is %r"
60
60
% (testtools.__file__, _testtools_version))
61
61
from testtools import content
63
64
from bzrlib import (
68
commands as _mod_commands,
77
plugin as _mod_plugin,
78
84
transport as _mod_transport,
82
import bzrlib.commands
83
import bzrlib.timestamp
85
import bzrlib.inventory
86
import bzrlib.iterablefile
89
88
import bzrlib.lsprof
90
89
except ImportError:
91
90
# lsprof not available
95
92
from bzrlib.smart import client, request
97
from bzrlib import symbol_versioning
98
from bzrlib.symbol_versioning import (
106
93
from bzrlib.transport import (
110
from bzrlib.trace import mutter, note
111
97
from bzrlib.tests import (
138
123
TestSuite = TestUtil.TestSuite
139
124
TestLoader = TestUtil.TestLoader
126
# Tests should run in a clean and clearly defined environment. The goal is to
127
# keep them isolated from the running environment as mush as possible. The test
128
# framework ensures the variables defined below are set (or deleted if the
129
# value is None) before a test is run and reset to their original value after
130
# the test is run. Generally if some code depends on an environment variable,
131
# the tests should start without this variable in the environment. There are a
132
# few exceptions but you shouldn't violate this rule lightly.
136
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
137
# tests do check our impls match APPDATA
138
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
142
'BZREMAIL': None, # may still be present in the environment
143
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
144
'BZR_PROGRESS_BAR': None,
146
'BZR_PLUGIN_PATH': None,
147
'BZR_DISABLE_PLUGINS': None,
148
'BZR_PLUGINS_AT': None,
149
'BZR_CONCURRENCY': None,
150
# Make sure that any text ui tests are consistent regardless of
151
# the environment the test case is run in; you may want tests that
152
# test other combinations. 'dumb' is a reasonable guess for tests
153
# going to a pipe or a StringIO.
159
'SSH_AUTH_SOCK': None,
169
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
170
# least. If you do (care), please update this comment
174
'BZR_REMOTE_PATH': None,
175
# Generally speaking, we don't want apport reporting on crashes in
176
# the test envirnoment unless we're specifically testing apport,
177
# so that it doesn't leak into the real system environment. We
178
# use an env var so it propagates to subprocesses.
179
'APPORT_DISABLE': '1',
183
def override_os_environ(test, env=None):
184
"""Modify os.environ keeping a copy.
186
:param test: A test instance
188
:param env: A dict containing variable definitions to be installed
191
env = isolated_environ
192
test._original_os_environ = dict([(var, value)
193
for var, value in os.environ.iteritems()])
194
for var, value in env.iteritems():
195
osutils.set_or_unset_env(var, value)
196
if var not in test._original_os_environ:
197
# The var is new, add it with a value of None, so
198
# restore_os_environ will delete it
199
test._original_os_environ[var] = None
202
def restore_os_environ(test):
203
"""Restore os.environ to its original state.
205
:param test: A test instance previously passed to override_os_environ.
207
for var, value in test._original_os_environ.iteritems():
208
# Restore the original value (or delete it if the value has been set to
209
# None in override_os_environ).
210
osutils.set_or_unset_env(var, value)
141
213
class ExtendedTestResult(testtools.TextTestResult):
142
214
"""Accepts, reports and accumulates the results of running tests.
301
373
addOnException = getattr(test, "addOnException", None)
302
374
if addOnException is not None:
303
375
addOnException(self._record_traceback_from_test)
304
# Only check for thread leaks if the test case supports cleanups
305
addCleanup = getattr(test, "addCleanup", None)
306
if addCleanup is not None:
307
addCleanup(self._check_leaked_threads, test)
376
# Only check for thread leaks on bzrlib derived test cases
377
if isinstance(test, TestCase):
378
test.addCleanup(self._check_leaked_threads, test)
309
380
def startTests(self):
310
381
self.report_tests_starting()
807
881
return NullProgressView()
884
def isolated_doctest_setUp(test):
885
override_os_environ(test)
888
def isolated_doctest_tearDown(test):
889
restore_os_environ(test)
892
def IsolatedDocTestSuite(*args, **kwargs):
893
"""Overrides doctest.DocTestSuite to handle isolation.
895
The method is really a factory and users are expected to use it as such.
898
kwargs['setUp'] = isolated_doctest_setUp
899
kwargs['tearDown'] = isolated_doctest_tearDown
900
return doctest.DocTestSuite(*args, **kwargs)
810
903
class TestCase(testtools.TestCase):
811
904
"""Base class for bzr unit tests.
903
1000
for key, (parent, name) in known_hooks.iter_parent_objects():
904
1001
current_hooks = getattr(parent, name)
905
1002
self._preserved_hooks[parent] = (name, current_hooks)
1003
self._preserved_lazy_hooks = hooks._lazy_hooks
1004
hooks._lazy_hooks = {}
906
1005
self.addCleanup(self._restoreHooks)
907
1006
for key, (parent, name) in known_hooks.iter_parent_objects():
908
1007
factory = known_hooks.get(key)
1168
1267
'st_mtime did not match')
1169
1268
self.assertEqual(expected.st_ctime, actual.st_ctime,
1170
1269
'st_ctime did not match')
1171
if sys.platform != 'win32':
1270
if sys.platform == 'win32':
1172
1271
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1173
1272
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1174
# odd. Regardless we shouldn't actually try to assert anything
1175
# about their values
1273
# odd. We just force it to always be 0 to avoid any problems.
1274
self.assertEqual(0, expected.st_dev)
1275
self.assertEqual(0, actual.st_dev)
1276
self.assertEqual(0, expected.st_ino)
1277
self.assertEqual(0, actual.st_ino)
1176
1279
self.assertEqual(expected.st_dev, actual.st_dev,
1177
1280
'st_dev did not match')
1178
1281
self.assertEqual(expected.st_ino, actual.st_ino,
1244
1346
if haystack.find(needle) == -1:
1245
1347
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1349
def assertNotContainsString(self, haystack, needle):
1350
if haystack.find(needle) != -1:
1351
self.fail("string %r found in '''%s'''" % (needle, haystack))
1247
1353
def assertSubset(self, sublist, superlist):
1248
1354
"""Assert that every entry in sublist is present in superlist."""
1249
1355
missing = set(sublist) - set(superlist)
1355
1461
self.assertEqual(expected_docstring, obj.__doc__)
1463
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1357
1464
def failUnlessExists(self, path):
1465
return self.assertPathExists(path)
1467
def assertPathExists(self, path):
1358
1468
"""Fail unless path or paths, which may be abs or relative, exist."""
1359
1469
if not isinstance(path, basestring):
1361
self.failUnlessExists(p)
1471
self.assertPathExists(p)
1363
self.failUnless(osutils.lexists(path),path+" does not exist")
1473
self.assertTrue(osutils.lexists(path),
1474
path + " does not exist")
1476
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1365
1477
def failIfExists(self, path):
1478
return self.assertPathDoesNotExist(path)
1480
def assertPathDoesNotExist(self, path):
1366
1481
"""Fail if path or paths, which may be abs or relative, exist."""
1367
1482
if not isinstance(path, basestring):
1369
self.failIfExists(p)
1484
self.assertPathDoesNotExist(p)
1371
self.failIf(osutils.lexists(path),path+" exists")
1486
self.assertFalse(osutils.lexists(path),
1373
1489
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1374
1490
"""A helper for callDeprecated and applyDeprecated.
1498
1614
Close the file and delete it, unless setKeepLogfile was called.
1500
if bzrlib.trace._trace_file:
1616
if trace._trace_file:
1501
1617
# flush the log file, to get all content
1502
bzrlib.trace._trace_file.flush()
1503
bzrlib.trace.pop_log_file(self._log_memento)
1618
trace._trace_file.flush()
1619
trace.pop_log_file(self._log_memento)
1504
1620
# Cache the log result and delete the file on disk
1505
1621
self._get_log(False)
1536
1652
setattr(obj, attr_name, new)
1655
def overrideEnv(self, name, new):
1656
"""Set an environment variable, and reset it after the test.
1658
:param name: The environment variable name.
1660
:param new: The value to set the variable to. If None, the
1661
variable is deleted from the environment.
1663
:returns: The actual variable value.
1665
value = osutils.set_or_unset_env(name, new)
1666
self.addCleanup(osutils.set_or_unset_env, name, value)
1539
1669
def _cleanEnvironment(self):
1541
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1542
'HOME': os.getcwd(),
1543
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1544
# tests do check our impls match APPDATA
1545
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1549
'BZREMAIL': None, # may still be present in the environment
1550
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1551
'BZR_PROGRESS_BAR': None,
1553
'BZR_PLUGIN_PATH': None,
1554
'BZR_DISABLE_PLUGINS': None,
1555
'BZR_PLUGINS_AT': None,
1556
'BZR_CONCURRENCY': None,
1557
# Make sure that any text ui tests are consistent regardless of
1558
# the environment the test case is run in; you may want tests that
1559
# test other combinations. 'dumb' is a reasonable guess for tests
1560
# going to a pipe or a StringIO.
1564
'BZR_COLUMNS': '80',
1566
'SSH_AUTH_SOCK': None,
1570
'https_proxy': None,
1571
'HTTPS_PROXY': None,
1576
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1577
# least. If you do (care), please update this comment
1581
'BZR_REMOTE_PATH': None,
1582
# Generally speaking, we don't want apport reporting on crashes in
1583
# the test envirnoment unless we're specifically testing apport,
1584
# so that it doesn't leak into the real system environment. We
1585
# use an env var so it propagates to subprocesses.
1586
'APPORT_DISABLE': '1',
1589
self.addCleanup(self._restoreEnvironment)
1590
for name, value in new_env.iteritems():
1591
self._captureVar(name, value)
1593
def _captureVar(self, name, newvalue):
1594
"""Set an environment variable, and reset it when finished."""
1595
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1597
def _restoreEnvironment(self):
1598
for name, value in self._old_env.iteritems():
1599
osutils.set_or_unset_env(name, value)
1670
for name, value in isolated_environ.iteritems():
1671
self.overrideEnv(name, value)
1601
1673
def _restoreHooks(self):
1602
1674
for klass, (name, hooks) in self._preserved_hooks.items():
1603
1675
setattr(klass, name, hooks)
1676
hooks._lazy_hooks = self._preserved_lazy_hooks
1605
1678
def knownFailure(self, reason):
1606
1679
"""This test has failed for some known reason."""
2045
2119
if retcode is not None and retcode != process.returncode:
2046
2120
if process_args is None:
2047
2121
process_args = "(unknown args)"
2048
mutter('Output of bzr %s:\n%s', process_args, out)
2049
mutter('Error for bzr %s:\n%s', process_args, err)
2122
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2123
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2050
2124
self.fail('Command bzr %s failed with retcode %s != %s'
2051
2125
% (process_args, retcode, process.returncode))
2052
2126
return [out, err]
2439
2513
test_home_dir = self.test_home_dir
2440
2514
if isinstance(test_home_dir, unicode):
2441
2515
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2442
os.environ['HOME'] = test_home_dir
2443
os.environ['BZR_HOME'] = test_home_dir
2516
self.overrideEnv('HOME', test_home_dir)
2517
self.overrideEnv('BZR_HOME', test_home_dir)
2445
2519
def setUp(self):
2446
2520
super(TestCaseWithMemoryTransport, self).setUp()
3653
3728
'bzrlib.tests.per_repository',
3654
3729
'bzrlib.tests.per_repository_chk',
3655
3730
'bzrlib.tests.per_repository_reference',
3731
'bzrlib.tests.per_repository_vf',
3656
3732
'bzrlib.tests.per_uifactory',
3657
3733
'bzrlib.tests.per_versionedfile',
3658
3734
'bzrlib.tests.per_workingtree',
3692
3768
'bzrlib.tests.test_commit_merge',
3693
3769
'bzrlib.tests.test_config',
3694
3770
'bzrlib.tests.test_conflicts',
3771
'bzrlib.tests.test_controldir',
3695
3772
'bzrlib.tests.test_counted_lock',
3696
3773
'bzrlib.tests.test_crash',
3697
3774
'bzrlib.tests.test_decorators',
3748
3825
'bzrlib.tests.test_merge3',
3749
3826
'bzrlib.tests.test_merge_core',
3750
3827
'bzrlib.tests.test_merge_directive',
3828
'bzrlib.tests.test_mergetools',
3751
3829
'bzrlib.tests.test_missing',
3752
3830
'bzrlib.tests.test_msgeditor',
3753
3831
'bzrlib.tests.test_multiparent',
3803
3881
'bzrlib.tests.test_testament',
3804
3882
'bzrlib.tests.test_textfile',
3805
3883
'bzrlib.tests.test_textmerge',
3884
'bzrlib.tests.test_cethread',
3806
3885
'bzrlib.tests.test_timestamp',
3807
3886
'bzrlib.tests.test_trace',
3808
3887
'bzrlib.tests.test_transactions',