6
The Importance of Testing
7
=========================
9
Reliability is a critical success factor for any Version Control System.
10
We want Bazaar to be highly reliable across multiple platforms while
11
evolving over time to meet the needs of its community.
13
In a nutshell, this is what we expect and encourage:
15
* New functionality should have test cases. Preferably write the
16
test before writing the code.
18
In general, you can test at either the command-line level or the
19
internal API level. See `Writing tests`_ below for more detail.
21
* Try to practice Test-Driven Development: before fixing a bug, write a
22
test case so that it does not regress. Similarly for adding a new
23
feature: write a test case for a small version of the new feature before
24
starting on the code itself. Check the test fails on the old code, then
25
add the feature or fix and check it passes.
27
By doing these things, the Bazaar team gets increased confidence that
28
changes do what they claim to do, whether provided by the core team or
29
by community members. Equally importantly, we can be surer that changes
30
down the track do not break new features or bug fixes that you are
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?
39
Running the Test Suite
40
======================
42
Currently, bzr selftest is used to invoke tests.
43
You can provide a pattern argument to run a subset. For example,
44
to run just the blackbox tests, run::
46
./bzr selftest -v blackbox
48
To skip a particular test (or set of tests), use the --exclude option
49
(shorthand -x) like so::
51
./bzr selftest -v -x blackbox
53
To ensure that all tests are being run and succeeding, you can use the
54
--strict option which will fail if there are any missing features or known
57
./bzr selftest --strict
59
To list tests without running them, use the --list-only option like so::
61
./bzr selftest --list-only
63
This option can be combined with other selftest options (like -x) and
64
filter patterns to understand their effect.
66
Once you understand how to create a list of tests, you can use the --load-list
67
option to run only a restricted set of tests that you kept in a file, one test
68
id by line. Keep in mind that this will never be sufficient to validate your
69
modifications, you still need to run the full test suite for that, but using it
70
can help in some cases (like running only the failed tests for some time)::
72
./bzr selftest -- load-list my_failing_tests
74
This option can also be combined with other selftest options, including
75
patterns. It has some drawbacks though, the list can become out of date pretty
76
quick when doing Test Driven Development.
78
To address this concern, there is another way to run a restricted set of tests:
79
the --starting-with option will run only the tests whose name starts with the
80
specified string. It will also avoid loading the other tests and as a
81
consequence starts running your tests quicker::
83
./bzr selftest --starting-with bzrlib.blackbox
85
This option can be combined with all the other selftest options including
86
--load-list. The later is rarely used but allows to run a subset of a list of
87
failing tests for example.
90
Test suite debug flags
91
----------------------
93
Similar to the global ``-Dfoo`` debug options, bzr selftest accepts
94
``-E=foo`` debug flags. These flags are:
96
:allow_debug: do *not* clear the global debug flags when running a test.
97
This can provide useful logging to help debug test failures when used
98
with e.g. ``bzr -Dhpss selftest -E=allow_debug``
104
Where should I put a new test?
105
------------------------------
107
Bzrlib's tests are organised by the type of test. Most of the tests in
108
bzr's test suite belong to one of these categories:
111
- Blackbox (UI) tests
112
- Per-implementation tests
115
A quick description of these test types and where they belong in bzrlib's
116
source follows. Not all tests fall neatly into one of these categories;
117
in those cases use your judgement.
123
Unit tests make up the bulk of our test suite. These are tests that are
124
focused on exercising a single, specific unit of the code as directly
125
as possible. Each unit test is generally fairly short and runs very
128
They are found in ``bzrlib/tests/test_*.py``. So in general tests should
129
be placed in a file named test_FOO.py where FOO is the logical thing under
132
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
133
See bzrlib/tests/test_sampler.py for a template test script.
139
Tests can be written for the UI or for individual areas of the library.
140
Choose whichever is appropriate: if adding a new command, or a new command
141
option, then you should be writing a UI test. If you are both adding UI
142
functionality and library functionality, you will want to write tests for
143
both the UI and the core behaviours. We call UI tests 'blackbox' tests
144
and they belong in ``bzrlib/tests/blackbox/*.py``.
146
When writing blackbox tests please honour the following conventions:
148
1. Place the tests for the command 'name' in
149
bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
150
to locate the test script for a faulty command.
152
2. Use the 'self.run_bzr("name")' utility function to invoke the command
153
rather than running bzr in a subprocess or invoking the
154
cmd_object.run() method directly. This is a lot faster than
155
subprocesses and generates the same logging output as running it in a
156
subprocess (which invoking the method directly does not).
158
3. Only test the one command in a single test script. Use the bzrlib
159
library when setting up tests and when evaluating the side-effects of
160
the command. We do this so that the library api has continual pressure
161
on it to be as functional as the command line in a simple manner, and
162
to isolate knock-on effects throughout the blackbox test suite when a
163
command changes its name or signature. Ideally only the tests for a
164
given command are affected when a given command is changed.
166
4. If you have a test which does actually require running bzr in a
167
subprocess you can use ``run_bzr_subprocess``. By default the spawned
168
process will not load plugins unless ``--allow-plugins`` is supplied.
171
Per-implementation tests
172
~~~~~~~~~~~~~~~~~~~~~~~~
174
Per-implementation tests are tests that are defined once and then run
175
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``.
183
These are really a sub-category of unit tests, but an important one.
189
We make selective use of doctests__. In general they should provide
190
*examples* within the API documentation which can incidentally be tested. We
191
don't try to test every important case using doctests |--| regular Python
192
tests are generally a better solution. That is, we just use doctests to
193
make our documentation testable, rather than as a way to make tests.
195
Most of these are in ``bzrlib/doc/api``. More additions are welcome.
197
__ http://docs.python.org/lib/module-doctest.html
203
``bzrlib/tests/script.py`` allows users to write tests in a syntax very close to a shell session,
204
using a restricted and limited set of commands that should be enough to mimic
205
most of the behaviours.
207
A script is a set of commands, each command is composed of:
209
* one mandatory command line,
210
* one optional set of input lines to feed the command,
211
* one optional set of output expected lines,
212
* one optional set of error expected lines.
214
Input, output and error lines can be specified in any order.
216
Except for the expected output, all lines start with a special
217
string (based on their origin when used under a Unix shell):
219
* '$ ' for the command,
221
* nothing for output,
224
Comments can be added anywhere, they start with '#' and end with
227
The execution stops as soon as an expected output or an expected error is not
230
When no output is specified, any ouput from the command is accepted
231
and execution continue.
233
If an error occurs and no expected error is specified, the execution stops.
235
An error is defined by a returned status different from zero, not by the
236
presence of text on the error stream.
238
The matching is done on a full string comparison basis unless '...' is used, in
239
which case expected output/errors can be less precise.
243
The following will succeeds only if 'bzr add' outputs 'adding file'::
248
If you want the command to succeed for any output, just use::
252
The following will stop with an error::
256
If you want it to succeed, use::
259
2> bzr: ERROR: unknown command "not-a-command"
261
You can use ellipsis (...) to replace any piece of text you don't want to be
264
$ bzr branch not-a-branch
265
2>bzr: ERROR: Not a branch...not-a-branch/".
267
This can be used to ignore entire lines too::
273
# And here we explain that surprising fourth line
280
You can check the content of a file with cat::
285
You can also check the existence of a file with cat, the following will fail if
286
the file doesn't exist::
300
In our enhancements to unittest we allow for some addition results beyond
301
just success or failure.
303
If a test can't be run, it can say that it's skipped by raising a special
304
exception. This is typically used in parameterized tests |--| for example
305
if a transport doesn't support setting permissions, we'll skip the tests
306
that relating to that. ::
309
return self.branch_format.initialize(repo.bzrdir)
310
except errors.UninitializableFormat:
311
raise tests.TestSkipped('Uninitializable branch format')
313
Raising TestSkipped is a good idea when you want to make it clear that the
314
test was not run, rather than just returning which makes it look as if it
317
Several different cases are distinguished:
320
Generic skip; the only type that was present up to bzr 0.18.
323
The test doesn't apply to the parameters with which it was run.
324
This is typically used when the test is being applied to all
325
implementations of an interface, but some aspects of the interface
326
are optional and not present in particular concrete
327
implementations. (Some tests that should raise this currently
328
either silently return or raise TestSkipped.) Another option is
329
to use more precise parameterization to avoid generating the test
333
The test can't be run because a dependency (typically a Python
334
library) is not available in the test environment. These
335
are in general things that the person running the test could fix
336
by installing the library. It's OK if some of these occur when
337
an end user runs the tests or if we're specifically testing in a
338
limited environment, but a full test should never see them.
340
See `Test feature dependencies`_ below.
343
The test exists but is known to fail, for example this might be
344
appropriate to raise if you've committed a test for a bug but not
345
the fix for it, or if something works on Unix but not on Windows.
347
Raising this allows you to distinguish these failures from the
348
ones that are not expected to fail. If the test would fail
349
because of something we don't expect or intend to fix,
350
KnownFailure is not appropriate, and TestNotApplicable might be
353
KnownFailure should be used with care as we don't want a
354
proliferation of quietly broken tests.
356
We plan to support three modes for running the test suite to control the
357
interpretation of these results. Strict mode is for use in situations
358
like merges to the mainline and releases where we want to make sure that
359
everything that can be tested has been tested. Lax mode is for use by
360
developers who want to temporarily tolerate some known failures. The
361
default behaviour is obtained by ``bzr selftest`` with no options, and
362
also (if possible) by running under another unittest harness.
364
======================= ======= ======= ========
365
result strict default lax
366
======================= ======= ======= ========
367
TestSkipped pass pass pass
368
TestNotApplicable pass pass pass
369
UnavailableFeature fail pass pass
370
KnownFailure fail pass pass
371
======================= ======= ======= ========
374
Test feature dependencies
375
-------------------------
377
Writing tests that require a feature
378
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
380
Rather than manually checking the environment in each test, a test class
381
can declare its dependence on some test features. The feature objects are
382
checked only once for each run of the whole test suite.
384
(For historical reasons, as of May 2007 many cases that should depend on
385
features currently raise TestSkipped.)
389
class TestStrace(TestCaseWithTransport):
391
_test_needs_features = [StraceFeature]
393
This means all tests in this class need the feature. If the feature is
394
not available the test will be skipped using UnavailableFeature.
396
Individual tests can also require a feature using the ``requireFeature``
399
self.requireFeature(StraceFeature)
401
Features already defined in bzrlib.tests include:
406
- UnicodeFilenameFeature,
407
- FTPServerFeature, and
408
- CaseInsensitiveFilesystemFeature.
411
Defining a new feature that tests can require
412
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
414
New features for use with ``_test_needs_features`` or ``requireFeature``
415
are defined by subclassing ``bzrlib.tests.Feature`` and overriding the
416
``_probe`` and ``feature_name`` methods. For example::
418
class _SymlinkFeature(Feature):
421
return osutils.has_symlinks()
423
def feature_name(self):
426
SymlinkFeature = _SymlinkFeature()
429
Testing exceptions and errors
430
-----------------------------
432
It's important to test handling of errors and exceptions. Because this
433
code is often not hit in ad-hoc testing it can often have hidden bugs --
434
it's particularly common to get NameError because the exception code
435
references a variable that has since been renamed.
437
.. TODO: Something about how to provoke errors in the right way?
439
In general we want to test errors at two levels:
441
1. A test in ``test_errors.py`` checking that when the exception object is
442
constructed with known parameters it produces an expected string form.
443
This guards against mistakes in writing the format string, or in the
444
``str`` representations of its parameters. There should be one for
445
each exception class.
447
2. Tests that when an api is called in a particular situation, it raises
448
an error of the expected class. You should typically use
449
``assertRaises``, which in the Bazaar test suite returns the exception
450
object to allow you to examine its parameters.
452
In some cases blackbox tests will also want to check error reporting. But
453
it can be difficult to provoke every error through the commandline
454
interface, so those tests are only done as needed |--| eg in response to a
455
particular bug or if the error is reported in an unusual way(?) Blackbox
456
tests should mostly be testing how the command-line interface works, so
457
should only test errors if there is something particular to the cli in how
458
they're displayed or handled.
464
The Python ``warnings`` module is used to indicate a non-fatal code
465
problem. Code that's expected to raise a warning can be tested through
468
The test suite can be run with ``-Werror`` to check no unexpected errors
471
However, warnings should be used with discretion. It's not an appropriate
472
way to give messages to the user, because the warning is normally shown
473
only once per source line that causes the problem. You should also think
474
about whether the warning is serious enought that it should be visible to
475
users who may not be able to fix it.
478
Interface implementation testing and test scenarios
479
---------------------------------------------------
481
There are several cases in Bazaar of multiple implementations of a common
482
conceptual interface. ("Conceptual" because it's not necessary for all
483
the implementations to share a base class, though they often do.)
484
Examples include transports and the working tree, branch and repository
487
In these cases we want to make sure that every implementation correctly
488
fulfils the interface requirements. For example, every Transport should
489
support the ``has()`` and ``get()`` and ``clone()`` methods. We have a
490
sub-suite of tests in ``test_transport_implementations``. (Most
491
per-implementation tests are in submodules of ``bzrlib.tests``, but not
492
the transport tests at the moment.)
494
These tests are repeated for each registered Transport, by generating a
495
new TestCase instance for the cross product of test methods and transport
496
implementations. As each test runs, it has ``transport_class`` and
497
``transport_server`` set to the class it should test. Most tests don't
498
access these directly, but rather use ``self.get_transport`` which returns
499
a transport of the appropriate type.
501
The goal is to run per-implementation only the tests that relate to that
502
particular interface. Sometimes we discover a bug elsewhere that happens
503
with only one particular transport. Once it's isolated, we can consider
504
whether a test should be added for that particular implementation,
505
or for all implementations of the interface.
507
The multiplication of tests for different implementations is normally
508
accomplished by overriding the ``load_tests`` function used to load tests
509
from a module. This function typically loads all the tests, then applies
510
a TestProviderAdapter to them, which generates a longer suite containing
511
all the test variations.
513
See also `Per-implementation tests`_ (above).
519
Some utilities are provided for generating variations of tests. This can
520
be used for per-implementation tests, or other cases where the same test
521
code needs to run several times on different scenarios.
523
The general approach is to define a class that provides test methods,
524
which depend on attributes of the test object being pre-set with the
525
values to which the test should be applied. The test suite should then
526
also provide a list of scenarios in which to run the tests.
528
Typically ``multiply_tests_from_modules`` should be called from the test
529
module's ``load_tests`` function.
535
We have a rich collection of tools to support writing tests. Please use
536
them in preference to ad-hoc solutions as they provide portability and
537
performance benefits.
540
TestCase and its subclasses
541
~~~~~~~~~~~~~~~~~~~~~~~~~~~
543
The ``bzrlib.tests`` module defines many TestCase classes to help you
547
A base TestCase that extends the Python standard library's
548
TestCase in several ways. It adds more assertion methods (e.g.
549
``assertContainsRe``), ``addCleanup``, and other features (see its API
550
docs for details). It also has a ``setUp`` that makes sure that
551
global state like registered hooks and loggers won't interfere with
552
your test. All tests should use this base class (whether directly or
555
TestCaseWithMemoryTransport
556
Extends TestCase and adds methods like ``get_transport``,
557
``make_branch`` and ``make_branch_builder``. The files created are
558
stored in a MemoryTransport that is discarded at the end of the test.
559
This class is good for tests that need to make branches or use
560
transports, but that don't require storing things on disk. All tests
561
that create bzrdirs should use this base class (either directly or via
562
a subclass) as it ensures that the test won't accidentally operate on
563
real branches in your filesystem.
566
Extends TestCaseWithMemoryTransport. For tests that really do need
567
files to be stored on disk, e.g. because a subprocess uses a file, or
568
for testing functionality that accesses the filesystem directly rather
569
than via the Transport layer (such as dirstate).
571
TestCaseWithTransport
572
Extends TestCaseInTempDir. Provides ``get_url`` and
573
``get_readonly_url`` facilities. Subclasses can control the
574
transports used by setting ``vfs_transport_factory``,
575
``transport_server`` and/or ``transport_readonly_server``.
578
See the API docs for more details.
584
When writing a test for a feature, it is often necessary to set up a
585
branch with a certain history. The ``BranchBuilder`` interface allows the
586
creation of test branches in a quick and easy manner. Here's a sample
589
builder = self.make_branch_builder('relpath')
590
builder.build_commit()
591
builder.build_commit()
592
builder.build_commit()
593
branch = builder.get_branch()
595
``make_branch_builder`` is a method of ``TestCaseWithMemoryTransport``.
597
Note that many current tests create test branches by inheriting from
598
``TestCaseWithTransport`` and using the ``make_branch_and_tree`` helper to
599
give them a ``WorkingTree`` that they can commit to. However, using the
600
newer ``make_branch_builder`` helper is preferred, because it can build
601
the changes in memory, rather than on disk. Tests that are explictly
602
testing how we work with disk objects should, of course, use a real
605
Please see bzrlib.branchbuilder for more details.
607
If you're going to examine the commit timestamps e.g. in a test for log
608
output, you should set the timestamp on the tree, rather than using fuzzy
615
The ``TreeBuilder`` interface allows the construction of arbitrary trees
616
with a declarative interface. A sample session might look like::
618
tree = self.make_branch_and_tree('path')
619
builder = TreeBuilder()
620
builder.start_tree(tree)
621
builder.build(['foo', "bar/", "bar/file"])
622
tree.commit('commit the tree')
623
builder.finish_tree()
625
Usually a test will create a tree using ``make_branch_and_memory_tree`` (a
626
method of ``TestCaseWithMemoryTransport``) or ``make_branch_and_tree`` (a
627
method of ``TestCaseWithTransport``).
629
Please see bzrlib.treebuilder for more details.
632
.. |--| unicode:: U+2014
added
removed
doc/developers/testing.txt
