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. To
148
generate a subunit test stream::
150
$ ./bzr selftest --subunit
152
Processing such a stream can be done using a variety of tools including:
154
* The builtin ``subunit2pyunit``, ``subunit-filter``, ``subunit-ls``,
155
``subunit2junitxml`` from the subunit project.
157
* tribunal_, a GUI for showing test results.
159
* testrepository_, a tool for gathering and managing test runs.
161
.. _subunit: https://launchpad.net/subunit/
162
.. _tribunal: https://launchpad.net/tribunal/
168
Bazaar ships with a config file for testrepository_. This can be very
169
useful for keeping track of failing tests and doing general workflow
170
support. To run tests using testrepository::
174
To run only failing tests::
176
$ testr run --failing
178
To run only some tests, without plugins::
180
$ test run test_selftest -- --no-plugins
182
See the testrepository documentation for more details.
184
.. _testrepository: https://launchpad.net/testrepository
189
Normally you should add or update a test for all bug fixes or new features
104
193
Where should I put a new test?
105
194
------------------------------
407
`bzrlib.tests.test_import_tariff` has some tests that measure how many
408
Python modules are loaded to run some representative commands.
410
We want to avoid loading code unnecessarily, for reasons including:
412
* Python modules are interpreted when they're loaded, either to define
413
classes or modules or perhaps to initialize some structures.
415
* With a cold cache we may incur blocking real disk IO for each module.
417
* Some modules depend on many others.
419
* Some optional modules such as `testtools` are meant to be soft
420
dependencies and only needed for particular cases. If they're loaded in
421
other cases then bzr may break for people who don't have those modules.
423
`test_import_tarrif` allows us to check that removal of imports doesn't
426
This is done by running the command in a subprocess with
427
``--profile-imports``. Starting a whole Python interpreter is pretty
428
slow, so we don't want exhaustive testing here, but just enough to guard
429
against distinct fixed problems.
431
Assertions about precisely what is loaded tend to be brittle so we instead
432
make assertions that particular things aren't loaded.
434
Unless selftest is run with ``--no-plugins``, modules will be loaded in
435
the usual way and checks made on what they cause to be loaded. This is
436
probably worth checking into, because many bzr users have at least some
437
plugins installed (and they're included in binary installers).
439
In theory, plugins might have a good reason to load almost anything:
440
someone might write a plugin that opens a network connection or pops up a
441
gui window every time you run 'bzr status'. However, it's more likely
442
that the code to do these things is just being loaded accidentally. We
443
might eventually need to have a way to make exceptions for particular
446
Some things to check:
448
* non-GUI commands shouldn't load GUI libraries
450
* operations on bzr native formats sholudn't load foreign branch libraries
452
* network code shouldn't be loaded for purely local operations
454
* particularly expensive Python built-in modules shouldn't be loaded
455
unless there is a good reason
458
Testing locking behaviour
459
-------------------------
461
You may want to write tests that particular objects are or aren't locked
462
during particular operations: see for example `bug 498409`__.
464
__ https://launchpad.net/bugs/498409
466
The `TestCase` base class registers hooks that record lock actions into
467
``._lock_actions`` in this format::
470
('acquired', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/branch-lockc4au55ppz8wdym11z1aq)),
471
('released', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/branch-lockc4au55ppz8wdym11z1aq)),
472
('acquired', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/repository/lockyxb3rn4sw1oyx1jzkt45)),
473
('released', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/repository/lockyxb3rn4sw1oyx1jzkt45)),
474
('acquired', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/branch/lockh8c6t28rcjdkgxtndbje)),
475
('released', LockResult(file:///tmp/testbzr-J2pcy2.tmp/.bzr/branch/lockh8c6t28rcjdkgxtndbje)),
478
Alternatively you can register your own hooks to make custom assertions:
479
see `TestCase._check_locks` for an example.
377
537
KnownFailure should be used with care as we don't want a
378
538
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
542
We plan to support three modes for running the test suite to control the
438
585
self.requireFeature(StraceFeature)
440
Features already defined in bzrlib.tests include:
445
- UnicodeFilenameFeature,
446
- FTPServerFeature, and
587
The old naming style for features is CamelCase, but because they're
588
actually instances not classses they're now given instance-style names
591
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
599
- UnicodeFilenameFeature
447
601
- CaseInsensitiveFilesystemFeature.
602
- chown_feature: The test can rely on OS being POSIX and python
604
- posix_permissions_feature: The test can use POSIX-style
605
user/group/other permission bits.
450
608
Defining a new feature that tests can require
465
623
SymlinkFeature = _SymlinkFeature()
625
A helper for handling running tests based on whether a python
626
module is available. This can handle 3rd-party dependencies (is
627
``paramiko`` available?) as well as stdlib (``termios``) or
628
extension modules (``bzrlib._groupcompress_pyx``). You create a
629
new feature instance with::
631
# in bzrlib/tests/features.py
632
apport = tests.ModuleAvailableFeature('apport')
635
# then in bzrlib/tests/test_apport.py
636
class TestApportReporting(TestCaseInTempDir):
638
_test_needs_features = [features.apport]
468
641
Testing exceptions and errors
469
642
-----------------------------
added
removed
doc/developers/testing.txt
