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
------------------------------
174
263
Per-implementation tests are tests that are defined once and then run
175
264
against multiple implementations of an interface. For example,
176
``test_transport_implementations.py`` defines tests that all Transport
177
implementations (local filesystem, HTTP, and so on) must pass.
179
They are found in ``bzrlib/tests/*_implementations/test_*.py``,
180
``bzrlib/tests/per_*/*.py``, and
181
``bzrlib/tests/test_*_implementations.py``.
265
``per_transport.py`` defines tests that all Transport implementations
266
(local filesystem, HTTP, and so on) must pass. They are found in
267
``bzrlib/tests/per_*/*.py``, and ``bzrlib/tests/per_*.py``.
183
269
These are really a sub-category of unit tests, but an important one.
271
Along the same lines are tests for extension modules. We generally have
272
both a pure-python and a compiled implementation for each module. As such,
273
we want to run the same tests against both implementations. These can
274
generally be found in ``bzrlib/tests/*__*.py`` since extension modules are
275
usually prefixed with an underscore. Since there are only two
276
implementations, we have a helper function
277
``bzrlib.tests.permute_for_extension``, which can simplify the
278
``load_tests`` implementation.
385
The actual use of ScriptRunner within a TestCase looks something like
388
def test_unshelve_keep(self):
391
sr.run_script(self, '''
393
$ bzr shelve --all -m Foo
396
$ bzr unshelve --keep
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
In order to test the locking behaviour of commands, it is possible to install
462
a hook that is called when a write lock is: acquired, released or broken.
463
(Read locks also exist, they cannot be discovered in this way.)
465
A hook can be installed by calling bzrlib.lock.Lock.hooks.install_named_hook.
466
The three valid hooks are: `lock_acquired`, `lock_released` and `lock_broken`.
473
lock.Lock.hooks.install_named_hook('lock_acquired',
474
locks_acquired.append, None)
475
lock.Lock.hooks.install_named_hook('lock_released',
476
locks_released.append, None)
478
`locks_acquired` will now receive a LockResult instance for all locks acquired
479
since the time the hook is installed.
481
The last part of the `lock_url` allows you to identify the type of object that is locked.
483
- BzrDir: `/branch-lock`
484
- Working tree: `/checkout/lock`
485
- Branch: `/branch/lock`
486
- Repository: `/repository/lock`
488
To test if a lock is a write lock on a working tree, one can do the following::
490
self.assertEndsWith(locks_acquired[0].lock_url, "/checkout/lock")
492
See bzrlib/tests/commands/test_revert.py for an example of how to use this for
399
600
self.requireFeature(StraceFeature)
401
Features already defined in bzrlib.tests include:
406
- UnicodeFilenameFeature,
407
- FTPServerFeature, and
602
The old naming style for features is CamelCase, but because they're
603
actually instances not classses they're now given instance-style names
606
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
614
- UnicodeFilenameFeature
408
616
- CaseInsensitiveFilesystemFeature.
617
- chown_feature: The test can rely on OS being POSIX and python
619
- posix_permissions_feature: The test can use POSIX-style
620
user/group/other permission bits.
411
623
Defining a new feature that tests can require
416
628
``_probe`` and ``feature_name`` methods. For example::
418
630
class _SymlinkFeature(Feature):
420
632
def _probe(self):
421
633
return osutils.has_symlinks()
423
635
def feature_name(self):
424
636
return 'symlinks'
426
638
SymlinkFeature = _SymlinkFeature()
640
A helper for handling running tests based on whether a python
641
module is available. This can handle 3rd-party dependencies (is
642
``paramiko`` available?) as well as stdlib (``termios``) or
643
extension modules (``bzrlib._groupcompress_pyx``). You create a
644
new feature instance with::
646
# in bzrlib/tests/features.py
647
apport = tests.ModuleAvailableFeature('apport')
650
# then in bzrlib/tests/test_apport.py
651
class TestApportReporting(TestCaseInTempDir):
653
_test_needs_features = [features.apport]
429
656
Testing exceptions and errors
430
657
-----------------------------
added
removed
doc/developers/testing.txt
