30
34
down the track do not break new features or bug fixes that you are
31
35
contributing today.
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?
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?
39
43
Running the Test Suite
40
44
======================
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
46
Currently, bzr selftest is used to invoke tests.
61
47
You can provide a pattern argument to run a subset. For example,
62
48
to run just the blackbox tests, run::
104
90
--load-list. The later is rarely used but allows to run a subset of a list of
105
91
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
94
Test suite debug flags
130
95
----------------------
230
178
Per-implementation tests are tests that are defined once and then run
231
179
against multiple implementations of an interface. For example,
232
``per_transport.py`` defines tests that all Transport implementations
233
(local filesystem, HTTP, and so on) must pass. They are found in
234
``bzrlib/tests/per_*/*.py``, and ``bzrlib/tests/per_*.py``.
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``.
236
187
These are really a sub-category of unit tests, but an important one.
238
Along the same lines are tests for extension modules. We generally have
239
both a pure-python and a compiled implementation for each module. As such,
240
we want to run the same tests against both implementations. These can
241
generally be found in ``bzrlib/tests/*__*.py`` since extension modules are
242
usually prefixed with an underscore. Since there are only two
243
implementations, we have a helper function
244
``bzrlib.tests.permute_for_extension``, which can simplify the
245
``load_tests`` implementation.
259
201
__ http://docs.python.org/lib/module-doctest.html
265
``bzrlib/tests/script.py`` allows users to write tests in a syntax very close to a shell session,
266
using a restricted and limited set of commands that should be enough to mimic
267
most of the behaviours.
269
A script is a set of commands, each command is composed of:
271
* one mandatory command line,
272
* one optional set of input lines to feed the command,
273
* one optional set of output expected lines,
274
* one optional set of error expected lines.
276
Input, output and error lines can be specified in any order.
278
Except for the expected output, all lines start with a special
279
string (based on their origin when used under a Unix shell):
281
* '$ ' for the command,
283
* nothing for output,
286
Comments can be added anywhere, they start with '#' and end with
289
The execution stops as soon as an expected output or an expected error is not
292
When no output is specified, any ouput from the command is accepted
293
and execution continue.
295
If an error occurs and no expected error is specified, the execution stops.
297
An error is defined by a returned status different from zero, not by the
298
presence of text on the error stream.
300
The matching is done on a full string comparison basis unless '...' is used, in
301
which case expected output/errors can be less precise.
305
The following will succeeds only if 'bzr add' outputs 'adding file'::
310
If you want the command to succeed for any output, just use::
314
The following will stop with an error::
318
If you want it to succeed, use::
321
2> bzr: ERROR: unknown command "not-a-command"
323
You can use ellipsis (...) to replace any piece of text you don't want to be
326
$ bzr branch not-a-branch
327
2>bzr: ERROR: Not a branch...not-a-branch/".
329
This can be used to ignore entire lines too::
335
# And here we explain that surprising fourth line
342
You can check the content of a file with cat::
347
You can also check the existence of a file with cat, the following will fail if
348
the file doesn't exist::
352
The actual use of ScriptRunner within a TestCase looks something like
355
def test_unshelve_keep(self):
358
sr.run_script(self, '''
360
$ bzr shelve --all -m Foo
363
$ bzr unshelve --keep
374
`bzrlib.tests.test_import_tariff` has some tests that measure how many
375
Python modules are loaded to run some representative commands.
377
We want to avoid loading code unnecessarily, for reasons including:
379
* Python modules are interpreted when they're loaded, either to define
380
classes or modules or perhaps to initialize some structures.
382
* With a cold cache we may incur blocking real disk IO for each module.
384
* Some modules depend on many others.
386
* Some optional modules such as `testtools` are meant to be soft
387
dependencies and only needed for particular cases. If they're loaded in
388
other cases then bzr may break for people who don't have those modules.
390
`test_import_tarrif` allows us to check that removal of imports doesn't
393
This is done by running the command in a subprocess with
394
``--profile-imports``. Starting a whole Python interpreter is pretty
395
slow, so we don't want exhaustive testing here, but just enough to guard
396
against distinct fixed problems.
398
Assertions about precisely what is loaded tend to be brittle so we instead
399
make assertions that particular things aren't loaded.
401
Unless selftest is run with ``--no-plugins``, modules will be loaded in
402
the usual way and checks made on what they cause to be loaded. This is
403
probably worth checking into, because many bzr users have at least some
404
plugins installed (and they're included in binary installers).
406
In theory, plugins might have a good reason to load almost anything:
407
someone might write a plugin that opens a network connection or pops up a
408
gui window every time you run 'bzr status'. However, it's more likely
409
that the code to do these things is just being loaded accidentally. We
410
might eventually need to have a way to make exceptions for particular
413
Some things to check:
415
* non-GUI commands shouldn't load GUI libraries
417
* operations on bzr native formats sholudn't load foreign branch libraries
419
* network code shouldn't be loaded for purely local operations
421
* particularly expensive Python built-in modules shouldn't be loaded
422
unless there is a good reason
553
328
``_probe`` and ``feature_name`` methods. For example::
555
330
class _SymlinkFeature(Feature):
557
332
def _probe(self):
558
333
return osutils.has_symlinks()
560
335
def feature_name(self):
561
336
return 'symlinks'
563
338
SymlinkFeature = _SymlinkFeature()
565
A helper for handling running tests based on whether a python
566
module is available. This can handle 3rd-party dependencies (is
567
``paramiko`` available?) as well as stdlib (``termios``) or
568
extension modules (``bzrlib._groupcompress_pyx``). You create a
569
new feature instance with::
571
# in bzrlib/tests/features.py
572
apport = tests.ModuleAvailableFeature('apport')
575
# then in bzrlib/tests/test_apport.py
576
class TestApportReporting(TestCaseInTempDir):
578
_test_needs_features = [features.apport]
581
341
Testing exceptions and errors
582
342
-----------------------------
added
removed
doc/developers/testing.txt
