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
------------------------
60
42
Currently, bzr selftest is used to invoke tests.
61
43
You can provide a pattern argument to run a subset. For example,
62
44
to run just the blackbox tests, run::
104
86
--load-list. The later is rarely used but allows to run a subset of a list of
105
87
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/
129
90
Test suite debug flags
130
91
----------------------
136
97
This can provide useful logging to help debug test failures when used
137
98
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
187
Babune continuous integration
188
-----------------------------
190
We have a Hudson continuous-integration system that automatically runs
191
tests across various platforms. In the future we plan to add more
192
combinations including testing plugins. See
193
<http://babune.ladeuil.net:24842/>. (Babune = Bazaar Buildbot Network.)
199
Normally you should add or update a test for all bug fixes or new features
203
104
Where should I put a new test?
204
105
------------------------------
395
296
The actual use of ScriptRunner within a TestCase looks something like
398
from bzrlib.tests import script
400
def test_unshelve_keep(self):
402
script.run_script(self, '''
404
$ bzr shelve --all -m Foo
407
$ bzr unshelve --keep
418
`bzrlib.tests.test_import_tariff` has some tests that measure how many
419
Python modules are loaded to run some representative commands.
421
We want to avoid loading code unnecessarily, for reasons including:
423
* Python modules are interpreted when they're loaded, either to define
424
classes or modules or perhaps to initialize some structures.
426
* With a cold cache we may incur blocking real disk IO for each module.
428
* Some modules depend on many others.
430
* Some optional modules such as `testtools` are meant to be soft
431
dependencies and only needed for particular cases. If they're loaded in
432
other cases then bzr may break for people who don't have those modules.
434
`test_import_tariff` allows us to check that removal of imports doesn't
437
This is done by running the command in a subprocess with
438
``--profile-imports``. Starting a whole Python interpreter is pretty
439
slow, so we don't want exhaustive testing here, but just enough to guard
440
against distinct fixed problems.
442
Assertions about precisely what is loaded tend to be brittle so we instead
443
make assertions that particular things aren't loaded.
445
Unless selftest is run with ``--no-plugins``, modules will be loaded in
446
the usual way and checks made on what they cause to be loaded. This is
447
probably worth checking into, because many bzr users have at least some
448
plugins installed (and they're included in binary installers).
450
In theory, plugins might have a good reason to load almost anything:
451
someone might write a plugin that opens a network connection or pops up a
452
gui window every time you run 'bzr status'. However, it's more likely
453
that the code to do these things is just being loaded accidentally. We
454
might eventually need to have a way to make exceptions for particular
457
Some things to check:
459
* non-GUI commands shouldn't load GUI libraries
461
* operations on bzr native formats sholudn't load foreign branch libraries
463
* network code shouldn't be loaded for purely local operations
465
* particularly expensive Python built-in modules shouldn't be loaded
466
unless there is a good reason
469
Testing locking behaviour
470
-------------------------
472
In order to test the locking behaviour of commands, it is possible to install
473
a hook that is called when a write lock is: acquired, released or broken.
474
(Read locks also exist, they cannot be discovered in this way.)
476
A hook can be installed by calling bzrlib.lock.Lock.hooks.install_named_hook.
477
The three valid hooks are: `lock_acquired`, `lock_released` and `lock_broken`.
484
lock.Lock.hooks.install_named_hook('lock_acquired',
485
locks_acquired.append, None)
486
lock.Lock.hooks.install_named_hook('lock_released',
487
locks_released.append, None)
489
`locks_acquired` will now receive a LockResult instance for all locks acquired
490
since the time the hook is installed.
492
The last part of the `lock_url` allows you to identify the type of object that is locked.
494
- BzrDir: `/branch-lock`
495
- Working tree: `/checkout/lock`
496
- Branch: `/branch/lock`
497
- Repository: `/repository/lock`
499
To test if a lock is a write lock on a working tree, one can do the following::
501
self.assertEndsWith(locks_acquired[0].lock_url, "/checkout/lock")
503
See bzrlib/tests/commands/test_revert.py for an example of how to use this for
299
def test_unshelve_keep(self):
302
sr.run_script(self, '''
304
$ bzr shelve --all -m Foo
307
$ bzr unshelve --keep
563
377
KnownFailure should be used with care as we don't want a
564
378
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
568
395
We plan to support three modes for running the test suite to control the
611
438
self.requireFeature(StraceFeature)
613
The old naming style for features is CamelCase, but because they're
614
actually instances not classses they're now given instance-style names
617
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
625
- UnicodeFilenameFeature
440
Features already defined in bzrlib.tests include:
445
- UnicodeFilenameFeature,
446
- FTPServerFeature, and
627
447
- CaseInsensitiveFilesystemFeature.
628
- chown_feature: The test can rely on OS being POSIX and python
630
- posix_permissions_feature: The test can use POSIX-style
631
user/group/other permission bits.
634
450
Defining a new feature that tests can require
649
465
SymlinkFeature = _SymlinkFeature()
651
A helper for handling running tests based on whether a python
652
module is available. This can handle 3rd-party dependencies (is
653
``paramiko`` available?) as well as stdlib (``termios``) or
654
extension modules (``bzrlib._groupcompress_pyx``). You create a
655
new feature instance with::
657
# in bzrlib/tests/features.py
658
apport = tests.ModuleAvailableFeature('apport')
661
# then in bzrlib/tests/test_apport.py
662
class TestApportReporting(TestCaseInTempDir):
664
_test_needs_features = [features.apport]
667
468
Testing exceptions and errors
668
469
-----------------------------
785
586
A base TestCase that extends the Python standard library's
786
TestCase in several ways. TestCase is build on
787
``testtools.TestCase``, which gives it support for more assertion
788
methods (e.g. ``assertContainsRe``), ``addCleanup``, and other
789
features (see its API docs for details). It also has a ``setUp`` that
790
makes sure that global state like registered hooks and loggers won't
791
interfere with your test. All tests should use this base class
792
(whether directly or via a subclass). Note that we are trying not to
793
add more assertions at this point, and instead to build up a library
794
of ``bzrlib.tests.matchers``.
587
TestCase in several ways. It adds more assertion methods (e.g.
588
``assertContainsRe``), ``addCleanup``, and other features (see its API
589
docs for details). It also has a ``setUp`` that makes sure that
590
global state like registered hooks and loggers won't interfere with
591
your test. All tests should use this base class (whether directly or
796
594
TestCaseWithMemoryTransport
797
595
Extends TestCase and adds methods like ``get_transport``,
added
removed
doc/developers/testing.txt
