6
6
The Importance of Testing
7
7
=========================
9
Reliability is a critical success factor for any Version Control System.
9
Reliability is a critical success factor for any version control system.
10
10
We want Bazaar to be highly reliable across multiple platforms while
11
11
evolving over time to meet the needs of its community.
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
Running tests in parallel
197
-------------------------
199
Bazaar can use subunit to spawn multiple test processes. There is
200
slightly more chance you will hit ordering or timing-dependent bugs but
203
$ ./bzr selftest --parallel=fork
205
Note that you will need the Subunit library
206
<https://launchpad.net/subunit/> to use this, which is in
207
``python-subunit`` on Ubuntu.
210
Running tests from a ramdisk
211
----------------------------
213
The tests create and delete a lot of temporary files. In some cases you
214
can make the test suite run much faster by running it on a ramdisk. For
218
$ sudo mount -t tmpfs none /ram
219
$ TMPDIR=/ram ./bzr selftest ...
221
You could also change ``/tmp`` in ``/etc/fstab`` to have type ``tmpfs``,
222
if you don't mind possibly losing other files in there when the machine
223
restarts. Add this line (if there is none for ``/tmp`` already)::
225
none /tmp tmpfs defaults 0 0
227
With a 6-core machine and ``--parallel=fork`` using a tmpfs doubles the
228
test execution speed.
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.
343
``bzrlib/tests/script.py`` allows users to write tests in a syntax very
344
close to a shell session, using a restricted and limited set of commands
345
that should be enough to mimic most of the behaviours.
302
347
A script is a set of commands, each command is composed of:
436
You can run files containing shell-like scripts with::
438
$ bzr test-script <script>
440
where ``<script>`` is the path to the file containing the shell-like script.
385
442
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
445
from bzrlib.tests import script
447
def test_unshelve_keep(self):
449
script.run_script(self, '''
451
$ bzr shelve --all -m Foo
454
$ bzr unshelve --keep
461
You can also test commands that read user interaction::
463
def test_confirm_action(self):
464
"""You can write tests that demonstrate user confirmation"""
465
commands.builtin_command_registry.register(cmd_test_confirm)
466
self.addCleanup(commands.builtin_command_registry.remove, 'test-confirm')
469
2>Really do it? [y/n]:
404
474
Import tariff tests
405
475
-------------------
420
490
dependencies and only needed for particular cases. If they're loaded in
421
491
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
493
`test_import_tariff` allows us to check that removal of imports doesn't
426
496
This is done by running the command in a subprocess with
653
723
_test_needs_features = [features.apport]
726
Testing deprecated code
727
-----------------------
729
When code is deprecated, it is still supported for some length of time,
730
usually until the next major version. The ``applyDeprecated`` helper
731
wraps calls to deprecated code to verify that it is correctly issuing the
732
deprecation warning, and also prevents the warnings from being printed
735
Typically patches that apply the ``@deprecated_function`` decorator should
736
update the accompanying tests to use the ``applyDeprecated`` wrapper.
738
``applyDeprecated`` is defined in ``bzrlib.tests.TestCase``. See the API
739
docs for more details.
656
742
Testing exceptions and errors
657
743
-----------------------------
731
817
whether a test should be added for that particular implementation,
732
818
or for all implementations of the interface.
734
The multiplication of tests for different implementations is normally
735
accomplished by overriding the ``load_tests`` function used to load tests
736
from a module. This function typically loads all the tests, then applies
737
a TestProviderAdapter to them, which generates a longer suite containing
738
all the test variations.
740
820
See also `Per-implementation tests`_ (above).
823
Test scenarios and variations
824
-----------------------------
746
826
Some utilities are provided for generating variations of tests. This can
747
827
be used for per-implementation tests, or other cases where the same test
752
832
values to which the test should be applied. The test suite should then
753
833
also provide a list of scenarios in which to run the tests.
755
Typically ``multiply_tests_from_modules`` should be called from the test
756
module's ``load_tests`` function.
835
A single *scenario* is defined by a `(name, parameter_dict)` tuple. The
836
short string name is combined with the name of the test method to form the
837
test instance name. The parameter dict is merged into the instance's
842
load_tests = load_tests_apply_scenarios
844
class TestCheckout(TestCase):
846
variations = multiply_scenarios(
847
VaryByRepositoryFormat(),
851
The `load_tests` declaration or definition should be near the top of the
852
file so its effect can be seen.
859
955
Please see bzrlib.treebuilder for more details.
958
Temporarily changing state
959
~~~~~~~~~~~~~~~~~~~~~~~~~~
961
If your test needs to temporarily mutate some global state, and you need
962
it restored at the end, you can say for example::
964
self.overrideAttr(osutils, '_cached_user_encoding', 'latin-1')
969
Our base ``TestCase`` class provides an ``addCleanup`` method, which
970
should be used instead of ``tearDown``. All the cleanups are run when the
971
test finishes, regardless of whether it passes or fails. If one cleanup
972
fails, later cleanups are still run.
974
(The same facility is available outside of tests through
981
Generally we prefer automated testing but sometimes a manual test is the
982
right thing, especially for performance tests that want to measure elapsed
983
time rather than effort.
985
Simulating slow networks
986
------------------------
988
To get realistically slow network performance for manually measuring
989
performance, we can simulate 500ms latency (thus 1000ms round trips)::
991
$ sudo tc qdisc add dev lo root netem delay 500ms
993
Normal system behaviour is restored with ::
995
$ sudo tc qdisc del dev lo root
997
A more precise version that only filters traffic to port 4155 is::
999
tc qdisc add dev lo root handle 1: prio
1000
tc qdisc add dev lo parent 1:3 handle 30: netem delay 500ms
1001
tc qdisc add dev lo parent 30:1 handle 40: prio
1002
tc filter add dev lo protocol ip parent 1:0 prio 3 u32 match ip dport 4155 0xffff flowid 1:3 handle 800::800
1003
tc filter add dev lo protocol ip parent 1:0 prio 3 u32 match ip sport 4155 0xffff flowid 1:3 handle 800::801
1005
and to remove this::
1007
tc filter del dev lo protocol ip parent 1: pref 3 u32
1008
tc qdisc del dev lo root handle 1:
1010
You can use similar code to add additional delay to a real network
1011
interface, perhaps only when talking to a particular server or pointing at
1012
a VM. For more information see <http://lartc.org/>.
862
1015
.. |--| unicode:: U+2014
1018
vim: ft=rst tw=74 ai et sw=4
added
removed
doc/developers/testing.txt
