39
39
Running the Test Suite
40
40
======================
42
As of Bazaar 2.1, you must have the testtools_ library installed to run
45
.. _testtools: https://launchpad.net/testtools/
47
To test all of Bazaar, just run::
51
With ``--verbose`` bzr will print the name of every test as it is run.
53
This should always pass, whether run from a source tree or an installed
54
copy of Bazaar. Please investigate and/or report any failures.
57
Running particular tests
58
------------------------
42
60
Currently, bzr selftest is used to invoke tests.
43
61
You can provide a pattern argument to run a subset. For example,
44
62
to run just the blackbox tests, run::
86
104
--load-list. The later is rarely used but allows to run a subset of a list of
87
105
failing tests for example.
110
To test only the bzr core, ignoring any plugins you may have installed,
113
./bzr --no-plugins selftest
115
Disabling crash reporting
116
-------------------------
118
By default Bazaar uses apport_ to report program crashes. In developing
119
Bazaar it's normal and expected to have it crash from time to time, at
120
least because a test failed if for no other reason.
122
Therefore you should probably add ``debug_flags = no_apport`` to your
123
``bazaar.conf`` file (in ``~/.bazaar/`` on Unix), so that failures just
124
print a traceback rather than writing a crash file.
126
.. _apport: https://launchpad.net/apport/
90
129
Test suite debug flags
91
130
----------------------
97
136
This can provide useful logging to help debug test failures when used
98
137
with e.g. ``bzr -Dhpss selftest -E=allow_debug``
139
Note that this will probably cause some tests to fail, because they
140
don't expect to run with any debug flags on.
146
Bazaar can optionally produce output in the machine-readable subunit_
147
format, so that test output can be post-processed by various tools.
149
.. _subunit: https://launchpad.net/subunit/
156
Normally you should add or update a test for all bug fixes or new features
104
160
Where should I put a new test?
105
161
------------------------------
374
`bzrlib.tests.test_import_tariff` has some tests that measure how many
375
Python modules are loaded to run some representative commands.
377
We want to avoid loading code unnecessarily, for reasons including:
379
* Python modules are interpreted when they're loaded, either to define
380
classes or modules or perhaps to initialize some structures.
382
* With a cold cache we may incur blocking real disk IO for each module.
384
* Some modules depend on many others.
386
* Some optional modules such as `testtools` are meant to be soft
387
dependencies and only needed for particular cases. If they're loaded in
388
other cases then bzr may break for people who don't have those modules.
390
`test_import_tarrif` allows us to check that removal of imports doesn't
393
This is done by running the command in a subprocess with
394
``--profile-imports``. Starting a whole Python interpreter is pretty
395
slow, so we don't want exhaustive testing here, but just enough to guard
396
against distinct fixed problems.
398
Assertions about precisely what is loaded tend to be brittle so we instead
399
make assertions that particular things aren't loaded.
401
Unless selftest is run with ``--no-plugins``, modules will be loaded in
402
the usual way and checks made on what they cause to be loaded. This is
403
probably worth checking into, because many bzr users have at least some
404
plugins installed (and they're included in binary installers).
406
In theory, plugins might have a good reason to load almost anything:
407
someone might write a plugin that opens a network connection or pops up a
408
gui window every time you run 'bzr status'. However, it's more likely
409
that the code to do these things is just being loaded accidentally. We
410
might eventually need to have a way to make exceptions for particular
413
Some things to check:
415
* non-GUI commands shouldn't load GUI libraries
417
* operations on bzr native formats sholudn't load foreign branch libraries
419
* network code shouldn't be loaded for purely local operations
421
* particularly expensive Python built-in modules shouldn't be loaded
422
unless there is a good reason
377
481
KnownFailure should be used with care as we don't want a
378
482
proliferation of quietly broken tests.
380
ModuleAvailableFeature
381
A helper for handling running tests based on whether a python
382
module is available. This can handle 3rd-party dependencies (is
383
``paramiko`` available?) as well as stdlib (``termios``) or
384
extension modules (``bzrlib._groupcompress_pyx``). You create a
385
new feature instance with::
387
MyModuleFeature = ModuleAvailableFeature('bzrlib.something')
390
def test_something(self):
391
self.requireFeature(MyModuleFeature)
392
something = MyModuleFeature.module
395
486
We plan to support three modes for running the test suite to control the
438
529
self.requireFeature(StraceFeature)
440
Features already defined in bzrlib.tests include:
445
- UnicodeFilenameFeature,
446
- FTPServerFeature, and
531
The old naming style for features is CamelCase, but because they're
532
actually instances not classses they're now given instance-style names
535
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
543
- UnicodeFilenameFeature
447
545
- CaseInsensitiveFilesystemFeature.
465
563
SymlinkFeature = _SymlinkFeature()
565
A helper for handling running tests based on whether a python
566
module is available. This can handle 3rd-party dependencies (is
567
``paramiko`` available?) as well as stdlib (``termios``) or
568
extension modules (``bzrlib._groupcompress_pyx``). You create a
569
new feature instance with::
571
# in bzrlib/tests/features.py
572
apport = tests.ModuleAvailableFeature('apport')
575
# then in bzrlib/tests/test_apport.py
576
class TestApportReporting(TestCaseInTempDir):
578
_test_needs_features = [features.apport]
468
581
Testing exceptions and errors
469
582
-----------------------------
added
removed
doc/developers/testing.txt
