7
7
=========================
9
9
Reliability is a critical success factor for any version control system.
10
We want Bazaar to be highly reliable across multiple platforms while
10
We want Breezy to be highly reliable across multiple platforms while
11
11
evolving over time to meet the needs of its community.
13
13
In a nutshell, this is what we expect and encourage:
24
24
starting on the code itself. Check the test fails on the old code, then
25
25
add the feature or fix and check it passes.
27
By doing these things, the Bazaar team gets increased confidence that
27
By doing these things, the Breezy team gets increased confidence that
28
28
changes do what they claim to do, whether provided by the core team or
29
29
by community members. Equally importantly, we can be surer that changes
30
30
down the track do not break new features or bug fixes that you are
31
31
contributing today.
33
As of September 2009, Bazaar ships with a test suite containing over
33
As of September 2009, Breezy ships with a test suite containing over
34
34
23,000 tests and growing. We are proud of it and want to remain so. As
35
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?
36
on your project to a product *without* a test suite like Breezy has?
39
39
Running the Test Suite
40
40
======================
42
As of Bazaar 2.1, you must have the testtools_ library installed to run
42
As of Breezy 2.1, you must have the testtools_ library installed to run
45
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.
47
To test all of Breezy, just run::
51
With ``--verbose`` brz will print the name of every test as it is run.
53
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.
54
copy of Breezy. Please investigate and/or report any failures.
57
57
Running particular tests
58
58
------------------------
60
Currently, bzr selftest is used to invoke tests.
60
Currently, brz selftest is used to invoke tests.
61
61
You can provide a pattern argument to run a subset. For example,
62
62
to run just the blackbox tests, run::
64
./bzr selftest -v blackbox
64
./brz selftest -v blackbox
66
66
To skip a particular test (or set of tests), use the --exclude option
67
67
(shorthand -x) like so::
69
./bzr selftest -v -x blackbox
69
./brz selftest -v -x blackbox
71
71
To ensure that all tests are being run and succeeding, you can use the
72
72
--strict option which will fail if there are any missing features or known
73
73
failures, like so::
75
./bzr selftest --strict
75
./brz selftest --strict
77
77
To list tests without running them, use the --list-only option like so::
79
./bzr selftest --list-only
79
./brz selftest --list-only
81
81
This option can be combined with other selftest options (like -x) and
82
82
filter patterns to understand their effect.
87
87
modifications, you still need to run the full test suite for that, but using it
88
88
can help in some cases (like running only the failed tests for some time)::
90
./bzr selftest -- load-list my_failing_tests
90
./brz selftest -- load-list my_failing_tests
92
92
This option can also be combined with other selftest options, including
93
93
patterns. It has some drawbacks though, the list can become out of date pretty
107
107
Disabling plugins
108
108
-----------------
110
To test only the bzr core, ignoring any plugins you may have installed,
110
To test only the brz core, ignoring any plugins you may have installed,
113
./bzr --no-plugins selftest
113
./brz --no-plugins selftest
115
115
Disabling crash reporting
116
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
118
By default Breezy uses apport_ to report program crashes. In developing
119
Breezy it's normal and expected to have it crash from time to time, at
120
120
least because a test failed if for no other reason.
122
122
Therefore you should probably add ``debug_flags = no_apport`` to your
129
129
Test suite debug flags
130
130
----------------------
132
Similar to the global ``-Dfoo`` debug options, bzr selftest accepts
132
Similar to the global ``-Dfoo`` debug options, brz selftest accepts
133
133
``-E=foo`` debug flags. These flags are:
135
135
:allow_debug: do *not* clear the global debug flags when running a test.
136
136
This can provide useful logging to help debug test failures when used
137
with e.g. ``bzr -Dhpss selftest -E=allow_debug``
137
with e.g. ``brz -Dhpss selftest -E=allow_debug``
139
139
Note that this will probably cause some tests to fail, because they
140
140
don't expect to run with any debug flags on.
146
Bazaar can optionally produce output in the machine-readable subunit_
146
Breezy can optionally produce output in the machine-readable subunit_
147
147
format, so that test output can be post-processed by various tools. To
148
148
generate a subunit test stream::
150
$ ./bzr selftest --subunit
150
$ ./brz selftest --subunit
152
152
Processing such a stream can be done using a variety of tools including:
184
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.)
196
187
Running tests in parallel
197
188
-------------------------
199
Bazaar can use subunit to spawn multiple test processes. There is
190
Breezy can use subunit to spawn multiple test processes. There is
200
191
slightly more chance you will hit ordering or timing-dependent bugs but
201
192
it's much faster::
203
$ ./bzr selftest --parallel=fork
194
$ ./brz selftest --parallel=fork
205
196
Note that you will need the Subunit library
206
197
<https://launchpad.net/subunit/> to use this, which is in
234
225
Normally you should add or update a test for all bug fixes or new features
238
229
Where should I put a new test?
239
230
------------------------------
241
Bzrlib's tests are organised by the type of test. Most of the tests in
242
bzr's test suite belong to one of these categories:
232
breezy's tests are organised by the type of test. Most of the tests in
233
brz's test suite belong to one of these categories:
245
236
- Blackbox (UI) tests
246
237
- Per-implementation tests
249
A quick description of these test types and where they belong in bzrlib's
240
A quick description of these test types and where they belong in breezy's
250
241
source follows. Not all tests fall neatly into one of these categories;
251
242
in those cases use your judgement.
259
250
as possible. Each unit test is generally fairly short and runs very
262
They are found in ``bzrlib/tests/test_*.py``. So in general tests should
253
They are found in ``breezy/tests/test_*.py``. So in general tests should
263
254
be placed in a file named test_FOO.py where FOO is the logical thing under
266
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
267
See bzrlib/tests/test_sampler.py for a template test script.
257
For example, tests for merge3 in breezy belong in breezy/tests/test_merge3.py.
258
See breezy/tests/test_sampler.py for a template test script.
270
261
Blackbox (UI) tests
275
266
option, then you should be writing a UI test. If you are both adding UI
276
267
functionality and library functionality, you will want to write tests for
277
268
both the UI and the core behaviours. We call UI tests 'blackbox' tests
278
and they belong in ``bzrlib/tests/blackbox/*.py``.
269
and they belong in ``breezy/tests/blackbox/*.py``.
280
271
When writing blackbox tests please honour the following conventions:
282
273
1. Place the tests for the command 'name' in
283
bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
274
breezy/tests/blackbox/test_name.py. This makes it easy for developers
284
275
to locate the test script for a faulty command.
286
2. Use the 'self.run_bzr("name")' utility function to invoke the command
287
rather than running bzr in a subprocess or invoking the
277
2. Use the 'self.run_brz("name")' utility function to invoke the command
278
rather than running brz in a subprocess or invoking the
288
279
cmd_object.run() method directly. This is a lot faster than
289
280
subprocesses and generates the same logging output as running it in a
290
281
subprocess (which invoking the method directly does not).
292
3. Only test the one command in a single test script. Use the bzrlib
283
3. Only test the one command in a single test script. Use the breezy
293
284
library when setting up tests and when evaluating the side-effects of
294
285
the command. We do this so that the library api has continual pressure
295
286
on it to be as functional as the command line in a simple manner, and
297
288
command changes its name or signature. Ideally only the tests for a
298
289
given command are affected when a given command is changed.
300
4. If you have a test which does actually require running bzr in a
301
subprocess you can use ``run_bzr_subprocess``. By default the spawned
291
4. If you have a test which does actually require running brz in a
292
subprocess you can use ``run_brz_subprocess``. By default the spawned
302
293
process will not load plugins unless ``--allow-plugins`` is supplied.
309
300
against multiple implementations of an interface. For example,
310
301
``per_transport.py`` defines tests that all Transport implementations
311
302
(local filesystem, HTTP, and so on) must pass. They are found in
312
``bzrlib/tests/per_*/*.py``, and ``bzrlib/tests/per_*.py``.
303
``breezy/tests/per_*/*.py``, and ``breezy/tests/per_*.py``.
314
305
These are really a sub-category of unit tests, but an important one.
316
307
Along the same lines are tests for extension modules. We generally have
317
308
both a pure-python and a compiled implementation for each module. As such,
318
309
we want to run the same tests against both implementations. These can
319
generally be found in ``bzrlib/tests/*__*.py`` since extension modules are
310
generally be found in ``breezy/tests/*__*.py`` since extension modules are
320
311
usually prefixed with an underscore. Since there are only two
321
312
implementations, we have a helper function
322
``bzrlib.tests.permute_for_extension``, which can simplify the
313
``breezy.tests.permute_for_extension``, which can simplify the
323
314
``load_tests`` implementation.
335
326
isolation, you're likely want to write unit tests anyway if only to get a
336
327
better control of the test environment.
338
Most of these are in ``bzrlib/doc/api``. More additions are welcome.
329
Most of these are in ``breezy/doc/api``. More additions are welcome.
340
331
__ http://docs.python.org/lib/module-doctest.html
342
333
There is an `assertDoctestExampleMatches` method in
343
`bzrlib.tests.TestCase` that allows you to match against doctest-style
334
`breezy.tests.TestCase` that allows you to match against doctest-style
344
335
string templates (including ``...`` to skip sections) from regular Python
392
The following will succeeds only if 'bzr add' outputs 'adding file'::
383
The following will succeeds only if 'brz add' outputs 'adding file'::
397
388
If you want the command to succeed for any output, just use::
403
394
or use the ``--quiet`` option::
407
398
The following will stop with an error::
411
402
If you want it to succeed, use::
414
2> bzr: ERROR: unknown command "not-a-command"
405
2> brz: ERROR: unknown command "not-a-command"
416
407
You can use ellipsis (...) to replace any piece of text you don't want to be
417
408
matched exactly::
419
$ bzr branch not-a-branch
420
2>bzr: ERROR: Not a branch...not-a-branch/".
410
$ brz branch not-a-branch
411
2>brz: ERROR: Not a branch...not-a-branch/".
422
413
This can be used to ignore entire lines too::
445
436
You can run files containing shell-like scripts with::
447
$ bzr test-script <script>
438
$ brz test-script <script>
449
440
where ``<script>`` is the path to the file containing the shell-like script.
451
442
The actual use of ScriptRunner within a TestCase looks something like
454
from bzrlib.tests import script
445
from breezy.tests import script
456
447
def test_unshelve_keep(self):
457
448
# some setup here
458
449
script.run_script(self, '''
460
$ bzr shelve -q --all -m Foo
451
$ brz shelve -q --all -m Foo
463
$ bzr unshelve -q --keep
454
$ brz unshelve -q --keep
526
517
Unless selftest is run with ``--no-plugins``, modules will be loaded in
527
518
the usual way and checks made on what they cause to be loaded. This is
528
probably worth checking into, because many bzr users have at least some
519
probably worth checking into, because many brz users have at least some
529
520
plugins installed (and they're included in binary installers).
531
522
In theory, plugins might have a good reason to load almost anything:
532
523
someone might write a plugin that opens a network connection or pops up a
533
gui window every time you run 'bzr status'. However, it's more likely
524
gui window every time you run 'brz status'. However, it's more likely
534
525
that the code to do these things is just being loaded accidentally. We
535
526
might eventually need to have a way to make exceptions for particular
554
545
a hook that is called when a write lock is: acquired, released or broken.
555
546
(Read locks also exist, they cannot be discovered in this way.)
557
A hook can be installed by calling bzrlib.lock.Lock.hooks.install_named_hook.
548
A hook can be installed by calling breezy.lock.Lock.hooks.install_named_hook.
558
549
The three valid hooks are: `lock_acquired`, `lock_released` and `lock_broken`.
651
642
like merges to the mainline and releases where we want to make sure that
652
643
everything that can be tested has been tested. Lax mode is for use by
653
644
developers who want to temporarily tolerate some known failures. The
654
default behaviour is obtained by ``bzr selftest`` with no options, and
645
default behaviour is obtained by ``brz selftest`` with no options, and
655
646
also (if possible) by running under another unittest harness.
657
648
======================= ======= ======= ========
732
723
A helper for handling running tests based on whether a python
733
724
module is available. This can handle 3rd-party dependencies (is
734
725
``paramiko`` available?) as well as stdlib (``termios``) or
735
extension modules (``bzrlib._groupcompress_pyx``). You create a
726
extension modules (``breezy._groupcompress_pyx``). You create a
736
727
new feature instance with::
738
# in bzrlib/tests/features.py
729
# in breezy/tests/features.py
739
730
apport = tests.ModuleAvailableFeature('apport')
742
# then in bzrlib/tests/test_apport.py
733
# then in breezy/tests/test_apport.py
743
734
class TestApportReporting(TestCaseInTempDir):
745
736
_test_needs_features = [features.apport]
798
789
2. Tests that when an api is called in a particular situation, it raises
799
790
an error of the expected class. You should typically use
800
``assertRaises``, which in the Bazaar test suite returns the exception
791
``assertRaises``, which in the Breezy test suite returns the exception
801
792
object to allow you to examine its parameters.
803
794
In some cases blackbox tests will also want to check error reporting. But
829
820
Interface implementation testing and test scenarios
830
821
---------------------------------------------------
832
There are several cases in Bazaar of multiple implementations of a common
823
There are several cases in Breezy of multiple implementations of a common
833
824
conceptual interface. ("Conceptual" because it's not necessary for all
834
825
the implementations to share a base class, though they often do.)
835
826
Examples include transports and the working tree, branch and repository
839
830
fulfils the interface requirements. For example, every Transport should
840
831
support the ``has()`` and ``get()`` and ``clone()`` methods. We have a
841
832
sub-suite of tests in ``test_transport_implementations``. (Most
842
per-implementation tests are in submodules of ``bzrlib.tests``, but not
833
per-implementation tests are in submodules of ``breezy.tests``, but not
843
834
the transport tests at the moment.)
845
836
These tests are repeated for each registered Transport, by generating a
914
905
interfere with your test. All tests should use this base class
915
906
(whether directly or via a subclass). Note that we are trying not to
916
907
add more assertions at this point, and instead to build up a library
917
of ``bzrlib.tests.matchers``.
908
of ``breezy.tests.matchers``.
919
910
TestCaseWithMemoryTransport
920
911
Extends TestCase and adds methods like ``get_transport``,
922
913
stored in a MemoryTransport that is discarded at the end of the test.
923
914
This class is good for tests that need to make branches or use
924
915
transports, but that don't require storing things on disk. All tests
925
that create bzrdirs should use this base class (either directly or via
916
that create brzdirs should use this base class (either directly or via
926
917
a subclass) as it ensures that the test won't accidentally operate on
927
918
real branches in your filesystem.
966
957
testing how we work with disk objects should, of course, use a real
969
Please see bzrlib.branchbuilder for more details.
960
Please see breezy.branchbuilder for more details.
971
962
If you're going to examine the commit timestamps e.g. in a test for log
972
963
output, you should set the timestamp on the tree, rather than using fuzzy
1057
1048
If yout test needs to temporarily change some environment variable value
1058
1049
(which generally means you want it restored at the end), you can use::
1060
self.overrideEnv('BZR_ENV_VAR', 'new_value')
1051
self.overrideEnv('brz_ENV_VAR', 'new_value')
1062
1053
If you want to remove a variable from the environment, you should use the
1063
1054
special ``None`` value::
1067
1058
If you add a new feature which depends on a new environment variable, make
1068
1059
sure it behaves properly when this variable is not defined (if applicable) and
1069
1060
if you need to enforce a specific default value, check the
1070
``TestCase._cleanEnvironment`` in ``bzrlib.tests.__init__.py`` which defines a
1061
``TestCase._cleanEnvironment`` in ``breezy.tests.__init__.py`` which defines a
1071
1062
proper set of values for all tests.
added
removed
doc/developers/testing.txt
