34
30
down the track do not break new features or bug fixes that you are
35
31
contributing today.
37
As of May 2008, Bazaar ships with a test suite containing over 12000 tests
38
and growing. We are proud of it and want to remain so. As community
39
members, we all benefit from it. Would you trust version control on
40
your project to a product *without* a test suite like Bazaar has?
33
As of September 2009, Bazaar ships with a test suite containing over
34
23,000 tests and growing. We are proud of it and want to remain so. As
35
community members, we all benefit from it. Would you trust version control
36
on your project to a product *without* a test suite like Bazaar has?
43
39
Running the Test Suite
44
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
------------------------
46
60
Currently, bzr selftest is used to invoke tests.
47
61
You can provide a pattern argument to run a subset. For example,
48
62
to run just the blackbox tests, run::
101
136
This can provide useful logging to help debug test failures when used
102
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
108
193
Where should I put a new test?
109
194
------------------------------
178
263
Per-implementation tests are tests that are defined once and then run
179
264
against multiple implementations of an interface. For example,
180
``test_transport_implementations.py`` defines tests that all Transport
181
implementations (local filesystem, HTTP, and so on) must pass.
183
They are found in ``bzrlib/tests/*_implementations/test_*.py``,
184
``bzrlib/tests/per_*/*.py``, and
185
``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``.
187
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.
201
292
__ http://docs.python.org/lib/module-doctest.html
298
``bzrlib/tests/script.py`` allows users to write tests in a syntax very close to a shell session,
299
using a restricted and limited set of commands that should be enough to mimic
300
most of the behaviours.
302
A script is a set of commands, each command is composed of:
304
* one mandatory command line,
305
* one optional set of input lines to feed the command,
306
* one optional set of output expected lines,
307
* one optional set of error expected lines.
309
Input, output and error lines can be specified in any order.
311
Except for the expected output, all lines start with a special
312
string (based on their origin when used under a Unix shell):
314
* '$ ' for the command,
316
* nothing for output,
319
Comments can be added anywhere, they start with '#' and end with
322
The execution stops as soon as an expected output or an expected error is not
325
When no output is specified, any ouput from the command is accepted
326
and execution continue.
328
If an error occurs and no expected error is specified, the execution stops.
330
An error is defined by a returned status different from zero, not by the
331
presence of text on the error stream.
333
The matching is done on a full string comparison basis unless '...' is used, in
334
which case expected output/errors can be less precise.
338
The following will succeeds only if 'bzr add' outputs 'adding file'::
343
If you want the command to succeed for any output, just use::
347
The following will stop with an error::
351
If you want it to succeed, use::
354
2> bzr: ERROR: unknown command "not-a-command"
356
You can use ellipsis (...) to replace any piece of text you don't want to be
359
$ bzr branch not-a-branch
360
2>bzr: ERROR: Not a branch...not-a-branch/".
362
This can be used to ignore entire lines too::
368
# And here we explain that surprising fourth line
375
You can check the content of a file with cat::
380
You can also check the existence of a file with cat, the following will fail if
381
the file doesn't exist::
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
459
774
A base TestCase that extends the Python standard library's
460
TestCase in several ways. It adds more assertion methods (e.g.
461
``assertContainsRe``), ``addCleanup``, and other features (see its API
462
docs for details). It also has a ``setUp`` that makes sure that
463
global state like registered hooks and loggers won't interfere with
464
your test. All tests should use this base class (whether directly or
775
TestCase in several ways. TestCase is build on
776
``testtools.TestCase``, which gives it support for more assertion
777
methods (e.g. ``assertContainsRe``), ``addCleanup``, and other
778
features (see its API docs for details). It also has a ``setUp`` that
779
makes sure that global state like registered hooks and loggers won't
780
interfere with your test. All tests should use this base class
781
(whether directly or via a subclass). Note that we are trying not to
782
add more assertions at this point, and instead to build up a library
783
of ``bzrlib.tests.matchers``.
467
785
TestCaseWithMemoryTransport
468
786
Extends TestCase and adds methods like ``get_transport``,
added
removed
doc/developers/testing.txt
