~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/testing.txt

cleanup of globster code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
====================
 
2
Bazaar Testing Guide
 
3
====================
 
4
 
 
5
 
 
6
The Importance of Testing
 
7
=========================
 
8
 
 
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.
 
12
 
 
13
In a nutshell, this is what we expect and encourage:
 
14
 
 
15
* New functionality should have test cases.  Preferably write the
 
16
  test before writing the code.
 
17
 
 
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.
 
20
 
 
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.
 
26
 
 
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
 
31
contributing today.
 
32
 
 
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
 
 
38
 
 
39
Running the Test Suite
 
40
======================
 
41
 
 
42
As of Bazaar 2.1, you must have the testtools_ library installed to run
 
43
the bzr test suite.
 
44
 
 
45
.. _testtools: https://launchpad.net/testtools/
 
46
 
 
47
To test all of Bazaar, just run::
 
48
 
 
49
  bzr selftest 
 
50
 
 
51
With ``--verbose`` bzr will print the name of every test as it is run.
 
52
 
 
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.
 
55
 
 
56
 
 
57
Running particular tests
 
58
------------------------
 
59
 
 
60
Currently, bzr selftest is used to invoke tests.
 
61
You can provide a pattern argument to run a subset. For example,
 
62
to run just the blackbox tests, run::
 
63
 
 
64
  ./bzr selftest -v blackbox
 
65
 
 
66
To skip a particular test (or set of tests), use the --exclude option
 
67
(shorthand -x) like so::
 
68
 
 
69
  ./bzr selftest -v -x blackbox
 
70
 
 
71
To ensure that all tests are being run and succeeding, you can use the
 
72
--strict option which will fail if there are any missing features or known
 
73
failures, like so::
 
74
 
 
75
  ./bzr selftest --strict
 
76
 
 
77
To list tests without running them, use the --list-only option like so::
 
78
 
 
79
  ./bzr selftest --list-only
 
80
 
 
81
This option can be combined with other selftest options (like -x) and
 
82
filter patterns to understand their effect.
 
83
 
 
84
Once you understand how to create a list of tests, you can use the --load-list
 
85
option to run only a restricted set of tests that you kept in a file, one test
 
86
id by line. Keep in mind that this will never be sufficient to validate your
 
87
modifications, you still need to run the full test suite for that, but using it
 
88
can help in some cases (like running only the failed tests for some time)::
 
89
 
 
90
  ./bzr selftest -- load-list my_failing_tests
 
91
 
 
92
This option can also be combined with other selftest options, including
 
93
patterns. It has some drawbacks though, the list can become out of date pretty
 
94
quick when doing Test Driven Development.
 
95
 
 
96
To address this concern, there is another way to run a restricted set of tests:
 
97
the --starting-with option will run only the tests whose name starts with the
 
98
specified string. It will also avoid loading the other tests and as a
 
99
consequence starts running your tests quicker::
 
100
 
 
101
  ./bzr selftest --starting-with bzrlib.blackbox
 
102
 
 
103
This option can be combined with all the other selftest options including
 
104
--load-list. The later is rarely used but allows to run a subset of a list of
 
105
failing tests for example.
 
106
 
 
107
Disabling plugins
 
108
-----------------
 
109
 
 
110
To test only the bzr core, ignoring any plugins you may have installed,
 
111
use::
 
112
 
 
113
  ./bzr --no-plugins selftest 
 
114
 
 
115
Disabling crash reporting
 
116
-------------------------
 
117
 
 
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.
 
121
 
 
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.
 
125
 
 
126
.. _apport: https://launchpad.net/apport/
 
127
 
 
128
 
 
129
Test suite debug flags
 
130
----------------------
 
131
 
 
132
Similar to the global ``-Dfoo`` debug options, bzr selftest accepts
 
133
``-E=foo`` debug flags.  These flags are:
 
134
 
 
135
:allow_debug: do *not* clear the global debug flags when running a test.
 
136
  This can provide useful logging to help debug test failures when used
 
137
  with e.g. ``bzr -Dhpss selftest -E=allow_debug``
 
138
 
 
139
  Note that this will probably cause some tests to fail, because they
 
140
  don't expect to run with any debug flags on.
 
141
 
 
142
 
 
143
Using subunit
 
144
-------------
 
145
 
 
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::
 
149
 
 
150
 $ ./bzr selftest --subunit
 
151
 
 
152
Processing such a stream can be done using a variety of tools including:
 
153
 
 
154
* The builtin ``subunit2pyunit``, ``subunit-filter``, ``subunit-ls``,
 
155
  ``subunit2junitxml`` from the subunit project.
 
156
 
 
157
* tribunal_, a GUI for showing test results.
 
158
 
 
159
* testrepository_, a tool for gathering and managing test runs.
 
160
 
 
161
.. _subunit: https://launchpad.net/subunit/
 
162
.. _tribunal: https://launchpad.net/tribunal/
 
163
 
 
164
 
 
165
Using testrepository
 
166
--------------------
 
167
 
 
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::
 
171
 
 
172
  $ testr run
 
173
 
 
174
To run only failing tests::
 
175
 
 
176
  $ testr run --failing
 
177
 
 
178
To run only some tests, without plugins::
 
179
 
 
180
  $ test run test_selftest -- --no-plugins
 
181
 
 
182
See the testrepository documentation for more details.
 
183
 
 
184
.. _testrepository: https://launchpad.net/testrepository
 
185
 
 
186
 
 
187
Babune continuous integration
 
188
-----------------------------
 
189
 
 
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.)
 
194
 
 
195
 
 
196
Writing Tests
 
197
=============
 
198
 
 
199
Normally you should add or update a test for all bug fixes or new features
 
200
in Bazaar.
 
201
 
 
202
 
 
203
Where should I put a new test?
 
204
------------------------------
 
205
 
 
206
Bzrlib's tests are organised by the type of test.  Most of the tests in
 
207
bzr's test suite belong to one of these categories:
 
208
 
 
209
 - Unit tests
 
210
 - Blackbox (UI) tests
 
211
 - Per-implementation tests
 
212
 - Doctests
 
213
 
 
214
A quick description of these test types and where they belong in bzrlib's
 
215
source follows.  Not all tests fall neatly into one of these categories;
 
216
in those cases use your judgement.
 
217
 
 
218
 
 
219
Unit tests
 
220
~~~~~~~~~~
 
221
 
 
222
Unit tests make up the bulk of our test suite.  These are tests that are
 
223
focused on exercising a single, specific unit of the code as directly
 
224
as possible.  Each unit test is generally fairly short and runs very
 
225
quickly.
 
226
 
 
227
They are found in ``bzrlib/tests/test_*.py``.  So in general tests should
 
228
be placed in a file named test_FOO.py where FOO is the logical thing under
 
229
test.
 
230
 
 
231
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
 
232
See bzrlib/tests/test_sampler.py for a template test script.
 
233
 
 
234
 
 
235
Blackbox (UI) tests
 
236
~~~~~~~~~~~~~~~~~~~
 
237
 
 
238
Tests can be written for the UI or for individual areas of the library.
 
239
Choose whichever is appropriate: if adding a new command, or a new command
 
240
option, then you should be writing a UI test.  If you are both adding UI
 
241
functionality and library functionality, you will want to write tests for
 
242
both the UI and the core behaviours.  We call UI tests 'blackbox' tests
 
243
and they belong in ``bzrlib/tests/blackbox/*.py``.
 
244
 
 
245
When writing blackbox tests please honour the following conventions:
 
246
 
 
247
 1. Place the tests for the command 'name' in
 
248
    bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
 
249
    to locate the test script for a faulty command.
 
250
 
 
251
 2. Use the 'self.run_bzr("name")' utility function to invoke the command
 
252
    rather than running bzr in a subprocess or invoking the
 
253
    cmd_object.run() method directly. This is a lot faster than
 
254
    subprocesses and generates the same logging output as running it in a
 
255
    subprocess (which invoking the method directly does not).
 
256
 
 
257
 3. Only test the one command in a single test script. Use the bzrlib
 
258
    library when setting up tests and when evaluating the side-effects of
 
259
    the command. We do this so that the library api has continual pressure
 
260
    on it to be as functional as the command line in a simple manner, and
 
261
    to isolate knock-on effects throughout the blackbox test suite when a
 
262
    command changes its name or signature. Ideally only the tests for a
 
263
    given command are affected when a given command is changed.
 
264
 
 
265
 4. If you have a test which does actually require running bzr in a
 
266
    subprocess you can use ``run_bzr_subprocess``. By default the spawned
 
267
    process will not load plugins unless ``--allow-plugins`` is supplied.
 
268
 
 
269
 
 
270
Per-implementation tests
 
271
~~~~~~~~~~~~~~~~~~~~~~~~
 
272
 
 
273
Per-implementation tests are tests that are defined once and then run
 
274
against multiple implementations of an interface.  For example,
 
275
``per_transport.py`` defines tests that all Transport implementations
 
276
(local filesystem, HTTP, and so on) must pass. They are found in
 
277
``bzrlib/tests/per_*/*.py``, and ``bzrlib/tests/per_*.py``.
 
278
 
 
279
These are really a sub-category of unit tests, but an important one.
 
280
 
 
281
Along the same lines are tests for extension modules. We generally have
 
282
both a pure-python and a compiled implementation for each module. As such,
 
283
we want to run the same tests against both implementations. These can
 
284
generally be found in ``bzrlib/tests/*__*.py`` since extension modules are
 
285
usually prefixed with an underscore. Since there are only two
 
286
implementations, we have a helper function
 
287
``bzrlib.tests.permute_for_extension``, which can simplify the
 
288
``load_tests`` implementation.
 
289
 
 
290
 
 
291
Doctests
 
292
~~~~~~~~
 
293
 
 
294
We make selective use of doctests__.  In general they should provide
 
295
*examples* within the API documentation which can incidentally be tested.  We
 
296
don't try to test every important case using doctests |--| regular Python
 
297
tests are generally a better solution.  That is, we just use doctests to
 
298
make our documentation testable, rather than as a way to make tests.
 
299
 
 
300
Most of these are in ``bzrlib/doc/api``.  More additions are welcome.
 
301
 
 
302
  __ http://docs.python.org/lib/module-doctest.html
 
303
 
 
304
 
 
305
Shell-like tests
 
306
----------------
 
307
 
 
308
``bzrlib/tests/script.py`` allows users to write tests in a syntax very close to a shell session,
 
309
using a restricted and limited set of commands that should be enough to mimic
 
310
most of the behaviours.
 
311
 
 
312
A script is a set of commands, each command is composed of:
 
313
 
 
314
 * one mandatory command line,
 
315
 * one optional set of input lines to feed the command,
 
316
 * one optional set of output expected lines,
 
317
 * one optional set of error expected lines.
 
318
 
 
319
Input, output and error lines can be specified in any order.
 
320
 
 
321
Except for the expected output, all lines start with a special
 
322
string (based on their origin when used under a Unix shell):
 
323
 
 
324
 * '$ ' for the command,
 
325
 * '<' for input,
 
326
 * nothing for output,
 
327
 * '2>' for errors,
 
328
 
 
329
Comments can be added anywhere, they start with '#' and end with
 
330
the line.
 
331
 
 
332
The execution stops as soon as an expected output or an expected error is not
 
333
matched.
 
334
 
 
335
When no output is specified, any ouput from the command is accepted
 
336
and execution continue.
 
337
 
 
338
If an error occurs and no expected error is specified, the execution stops.
 
339
 
 
340
An error is defined by a returned status different from zero, not by the
 
341
presence of text on the error stream.
 
342
 
 
343
The matching is done on a full string comparison basis unless '...' is used, in
 
344
which case expected output/errors can be less precise.
 
345
 
 
346
Examples:
 
347
 
 
348
The following will succeeds only if 'bzr add' outputs 'adding file'::
 
349
 
 
350
  $ bzr add file
 
351
  >adding file
 
352
 
 
353
If you want the command to succeed for any output, just use::
 
354
 
 
355
  $ bzr add file
 
356
 
 
357
The following will stop with an error::
 
358
 
 
359
  $ bzr not-a-command
 
360
 
 
361
If you want it to succeed, use::
 
362
 
 
363
  $ bzr not-a-command
 
364
  2> bzr: ERROR: unknown command "not-a-command"
 
365
 
 
366
You can use ellipsis (...) to replace any piece of text you don't want to be
 
367
matched exactly::
 
368
 
 
369
  $ bzr branch not-a-branch
 
370
  2>bzr: ERROR: Not a branch...not-a-branch/".
 
371
 
 
372
This can be used to ignore entire lines too::
 
373
 
 
374
  $ cat
 
375
  <first line
 
376
  <second line
 
377
  <third line
 
378
  # And here we explain that surprising fourth line
 
379
  <fourth line
 
380
  <last line
 
381
  >first line
 
382
  >...
 
383
  >last line
 
384
 
 
385
You can check the content of a file with cat::
 
386
 
 
387
  $ cat <file
 
388
  >expected content
 
389
 
 
390
You can also check the existence of a file with cat, the following will fail if
 
391
the file doesn't exist::
 
392
 
 
393
  $ cat file
 
394
 
 
395
The actual use of ScriptRunner within a TestCase looks something like
 
396
this::
 
397
 
 
398
    from bzrlib.tests import script
 
399
 
 
400
    def test_unshelve_keep(self):
 
401
        # some setup here
 
402
        script.run_script(self, '''
 
403
            $ bzr add file
 
404
            $ bzr shelve --all -m Foo
 
405
            $ bzr shelve --list
 
406
            1: Foo
 
407
            $ bzr unshelve --keep
 
408
            $ bzr shelve --list
 
409
            1: Foo
 
410
            $ cat file
 
411
            contents of file
 
412
            ''')
 
413
 
 
414
 
 
415
Import tariff tests
 
416
-------------------
 
417
 
 
418
`bzrlib.tests.test_import_tariff` has some tests that measure how many
 
419
Python modules are loaded to run some representative commands.
 
420
 
 
421
We want to avoid loading code unnecessarily, for reasons including:
 
422
 
 
423
* Python modules are interpreted when they're loaded, either to define
 
424
  classes or modules or perhaps to initialize some structures.
 
425
 
 
426
* With a cold cache we may incur blocking real disk IO for each module.
 
427
 
 
428
* Some modules depend on many others.
 
429
 
 
430
* Some optional modules such as `testtools` are meant to be soft
 
431
  dependencies and only needed for particular cases.  If they're loaded in
 
432
  other cases then bzr may break for people who don't have those modules.
 
433
  
 
434
`test_import_tariff` allows us to check that removal of imports doesn't
 
435
regress.
 
436
 
 
437
This is done by running the command in a subprocess with
 
438
``--profile-imports``.  Starting a whole Python interpreter is pretty
 
439
slow, so we don't want exhaustive testing here, but just enough to guard
 
440
against distinct fixed problems.
 
441
 
 
442
Assertions about precisely what is loaded tend to be brittle so we instead
 
443
make assertions that particular things aren't loaded.
 
444
 
 
445
Unless selftest is run with ``--no-plugins``, modules will be loaded in
 
446
the usual way and checks made on what they cause to be loaded.  This is
 
447
probably worth checking into, because many bzr users have at least some
 
448
plugins installed (and they're included in binary installers).
 
449
 
 
450
In theory, plugins might have a good reason to load almost anything:
 
451
someone might write a plugin that opens a network connection or pops up a
 
452
gui window every time you run 'bzr status'.  However, it's more likely
 
453
that the code to do these things is just being loaded accidentally.  We
 
454
might eventually need to have a way to make exceptions for particular
 
455
plugins.
 
456
 
 
457
Some things to check:
 
458
 
 
459
* non-GUI commands shouldn't load GUI libraries
 
460
 
 
461
* operations on bzr native formats sholudn't load foreign branch libraries
 
462
 
 
463
* network code shouldn't be loaded for purely local operations
 
464
 
 
465
* particularly expensive Python built-in modules shouldn't be loaded
 
466
  unless there is a good reason
 
467
 
 
468
 
 
469
Testing locking behaviour
 
470
-------------------------
 
471
 
 
472
In order to test the locking behaviour of commands, it is possible to install
 
473
a hook that is called when a write lock is: acquired, released or broken.
 
474
(Read locks also exist, they cannot be discovered in this way.)
 
475
 
 
476
A hook can be installed by calling bzrlib.lock.Lock.hooks.install_named_hook.
 
477
The three valid hooks are: `lock_acquired`, `lock_released` and `lock_broken`.
 
478
 
 
479
Example::
 
480
 
 
481
    locks_acquired = []
 
482
    locks_released = []
 
483
 
 
484
    lock.Lock.hooks.install_named_hook('lock_acquired',
 
485
        locks_acquired.append, None)
 
486
    lock.Lock.hooks.install_named_hook('lock_released',
 
487
        locks_released.append, None)
 
488
 
 
489
`locks_acquired` will now receive a LockResult instance for all locks acquired
 
490
since the time the hook is installed.
 
491
 
 
492
The last part of the `lock_url` allows you to identify the type of object that is locked.
 
493
 
 
494
- BzrDir: `/branch-lock`
 
495
- Working tree: `/checkout/lock`
 
496
- Branch: `/branch/lock`
 
497
- Repository: `/repository/lock`
 
498
 
 
499
To test if a lock is a write lock on a working tree, one can do the following::
 
500
 
 
501
    self.assertEndsWith(locks_acquired[0].lock_url, "/checkout/lock")
 
502
 
 
503
See bzrlib/tests/commands/test_revert.py for an example of how to use this for
 
504
testing locks.
 
505
 
 
506
 
 
507
Skipping tests
 
508
--------------
 
509
 
 
510
In our enhancements to unittest we allow for some addition results beyond
 
511
just success or failure.
 
512
 
 
513
If a test can't be run, it can say that it's skipped by raising a special
 
514
exception.  This is typically used in parameterized tests |--| for example
 
515
if a transport doesn't support setting permissions, we'll skip the tests
 
516
that relating to that.  ::
 
517
 
 
518
    try:
 
519
        return self.branch_format.initialize(repo.bzrdir)
 
520
    except errors.UninitializableFormat:
 
521
        raise tests.TestSkipped('Uninitializable branch format')
 
522
 
 
523
Raising TestSkipped is a good idea when you want to make it clear that the
 
524
test was not run, rather than just returning which makes it look as if it
 
525
was run and passed.
 
526
 
 
527
Several different cases are distinguished:
 
528
 
 
529
TestSkipped
 
530
        Generic skip; the only type that was present up to bzr 0.18.
 
531
 
 
532
TestNotApplicable
 
533
        The test doesn't apply to the parameters with which it was run.
 
534
        This is typically used when the test is being applied to all
 
535
        implementations of an interface, but some aspects of the interface
 
536
        are optional and not present in particular concrete
 
537
        implementations.  (Some tests that should raise this currently
 
538
        either silently return or raise TestSkipped.)  Another option is
 
539
        to use more precise parameterization to avoid generating the test
 
540
        at all.
 
541
 
 
542
UnavailableFeature
 
543
        The test can't be run because a dependency (typically a Python
 
544
        library) is not available in the test environment.  These
 
545
        are in general things that the person running the test could fix
 
546
        by installing the library.  It's OK if some of these occur when
 
547
        an end user runs the tests or if we're specifically testing in a
 
548
        limited environment, but a full test should never see them.
 
549
 
 
550
        See `Test feature dependencies`_ below.
 
551
 
 
552
KnownFailure
 
553
        The test exists but is known to fail, for example this might be
 
554
        appropriate to raise if you've committed a test for a bug but not
 
555
        the fix for it, or if something works on Unix but not on Windows.
 
556
 
 
557
        Raising this allows you to distinguish these failures from the
 
558
        ones that are not expected to fail.  If the test would fail
 
559
        because of something we don't expect or intend to fix,
 
560
        KnownFailure is not appropriate, and TestNotApplicable might be
 
561
        better.
 
562
 
 
563
        KnownFailure should be used with care as we don't want a
 
564
        proliferation of quietly broken tests.
 
565
 
 
566
 
 
567
 
 
568
We plan to support three modes for running the test suite to control the
 
569
interpretation of these results.  Strict mode is for use in situations
 
570
like merges to the mainline and releases where we want to make sure that
 
571
everything that can be tested has been tested.  Lax mode is for use by
 
572
developers who want to temporarily tolerate some known failures.  The
 
573
default behaviour is obtained by ``bzr selftest`` with no options, and
 
574
also (if possible) by running under another unittest harness.
 
575
 
 
576
======================= ======= ======= ========
 
577
result                  strict  default lax
 
578
======================= ======= ======= ========
 
579
TestSkipped             pass    pass    pass
 
580
TestNotApplicable       pass    pass    pass
 
581
UnavailableFeature      fail    pass    pass
 
582
KnownFailure            fail    pass    pass
 
583
======================= ======= ======= ========
 
584
 
 
585
 
 
586
Test feature dependencies
 
587
-------------------------
 
588
 
 
589
Writing tests that require a feature
 
590
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
591
 
 
592
Rather than manually checking the environment in each test, a test class
 
593
can declare its dependence on some test features.  The feature objects are
 
594
checked only once for each run of the whole test suite.
 
595
 
 
596
(For historical reasons, as of May 2007 many cases that should depend on
 
597
features currently raise TestSkipped.)
 
598
 
 
599
For example::
 
600
 
 
601
    class TestStrace(TestCaseWithTransport):
 
602
 
 
603
        _test_needs_features = [StraceFeature]
 
604
 
 
605
This means all tests in this class need the feature.  If the feature is
 
606
not available the test will be skipped using UnavailableFeature.
 
607
 
 
608
Individual tests can also require a feature using the ``requireFeature``
 
609
method::
 
610
 
 
611
    self.requireFeature(StraceFeature)
 
612
 
 
613
The old naming style for features is CamelCase, but because they're
 
614
actually instances not classses they're now given instance-style names
 
615
like ``apport``.
 
616
 
 
617
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
 
618
include:
 
619
 
 
620
 - apport
 
621
 - paramiko
 
622
 - SymlinkFeature
 
623
 - HardlinkFeature
 
624
 - OsFifoFeature
 
625
 - UnicodeFilenameFeature
 
626
 - FTPServerFeature
 
627
 - CaseInsensitiveFilesystemFeature.
 
628
 - chown_feature: The test can rely on OS being POSIX and python
 
629
   supporting os.chown.
 
630
 - posix_permissions_feature: The test can use POSIX-style
 
631
   user/group/other permission bits.
 
632
 
 
633
 
 
634
Defining a new feature that tests can require
 
635
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
636
 
 
637
New features for use with ``_test_needs_features`` or ``requireFeature``
 
638
are defined by subclassing ``bzrlib.tests.Feature`` and overriding the
 
639
``_probe`` and ``feature_name`` methods.  For example::
 
640
 
 
641
    class _SymlinkFeature(Feature):
 
642
 
 
643
        def _probe(self):
 
644
            return osutils.has_symlinks()
 
645
 
 
646
        def feature_name(self):
 
647
            return 'symlinks'
 
648
 
 
649
    SymlinkFeature = _SymlinkFeature()
 
650
 
 
651
A helper for handling running tests based on whether a python
 
652
module is available. This can handle 3rd-party dependencies (is
 
653
``paramiko`` available?) as well as stdlib (``termios``) or
 
654
extension modules (``bzrlib._groupcompress_pyx``). You create a
 
655
new feature instance with::
 
656
 
 
657
    # in bzrlib/tests/features.py
 
658
    apport = tests.ModuleAvailableFeature('apport')
 
659
 
 
660
 
 
661
    # then in bzrlib/tests/test_apport.py
 
662
    class TestApportReporting(TestCaseInTempDir):
 
663
 
 
664
        _test_needs_features = [features.apport]
 
665
 
 
666
 
 
667
Testing exceptions and errors
 
668
-----------------------------
 
669
 
 
670
It's important to test handling of errors and exceptions.  Because this
 
671
code is often not hit in ad-hoc testing it can often have hidden bugs --
 
672
it's particularly common to get NameError because the exception code
 
673
references a variable that has since been renamed.
 
674
 
 
675
.. TODO: Something about how to provoke errors in the right way?
 
676
 
 
677
In general we want to test errors at two levels:
 
678
 
 
679
1. A test in ``test_errors.py`` checking that when the exception object is
 
680
   constructed with known parameters it produces an expected string form.
 
681
   This guards against mistakes in writing the format string, or in the
 
682
   ``str`` representations of its parameters.  There should be one for
 
683
   each exception class.
 
684
 
 
685
2. Tests that when an api is called in a particular situation, it raises
 
686
   an error of the expected class.  You should typically use
 
687
   ``assertRaises``, which in the Bazaar test suite returns the exception
 
688
   object to allow you to examine its parameters.
 
689
 
 
690
In some cases blackbox tests will also want to check error reporting.  But
 
691
it can be difficult to provoke every error through the commandline
 
692
interface, so those tests are only done as needed |--| eg in response to a
 
693
particular bug or if the error is reported in an unusual way(?)  Blackbox
 
694
tests should mostly be testing how the command-line interface works, so
 
695
should only test errors if there is something particular to the cli in how
 
696
they're displayed or handled.
 
697
 
 
698
 
 
699
Testing warnings
 
700
----------------
 
701
 
 
702
The Python ``warnings`` module is used to indicate a non-fatal code
 
703
problem.  Code that's expected to raise a warning can be tested through
 
704
callCatchWarnings.
 
705
 
 
706
The test suite can be run with ``-Werror`` to check no unexpected errors
 
707
occur.
 
708
 
 
709
However, warnings should be used with discretion.  It's not an appropriate
 
710
way to give messages to the user, because the warning is normally shown
 
711
only once per source line that causes the problem.  You should also think
 
712
about whether the warning is serious enought that it should be visible to
 
713
users who may not be able to fix it.
 
714
 
 
715
 
 
716
Interface implementation testing and test scenarios
 
717
---------------------------------------------------
 
718
 
 
719
There are several cases in Bazaar of multiple implementations of a common
 
720
conceptual interface.  ("Conceptual" because it's not necessary for all
 
721
the implementations to share a base class, though they often do.)
 
722
Examples include transports and the working tree, branch and repository
 
723
classes.
 
724
 
 
725
In these cases we want to make sure that every implementation correctly
 
726
fulfils the interface requirements.  For example, every Transport should
 
727
support the ``has()`` and ``get()`` and ``clone()`` methods.  We have a
 
728
sub-suite of tests in ``test_transport_implementations``.  (Most
 
729
per-implementation tests are in submodules of ``bzrlib.tests``, but not
 
730
the transport tests at the moment.)
 
731
 
 
732
These tests are repeated for each registered Transport, by generating a
 
733
new TestCase instance for the cross product of test methods and transport
 
734
implementations.  As each test runs, it has ``transport_class`` and
 
735
``transport_server`` set to the class it should test.  Most tests don't
 
736
access these directly, but rather use ``self.get_transport`` which returns
 
737
a transport of the appropriate type.
 
738
 
 
739
The goal is to run per-implementation only the tests that relate to that
 
740
particular interface.  Sometimes we discover a bug elsewhere that happens
 
741
with only one particular transport.  Once it's isolated, we can consider
 
742
whether a test should be added for that particular implementation,
 
743
or for all implementations of the interface.
 
744
 
 
745
The multiplication of tests for different implementations is normally
 
746
accomplished by overriding the ``load_tests`` function used to load tests
 
747
from a module.  This function typically loads all the tests, then applies
 
748
a TestProviderAdapter to them, which generates a longer suite containing
 
749
all the test variations.
 
750
 
 
751
See also `Per-implementation tests`_ (above).
 
752
 
 
753
 
 
754
Test scenarios
 
755
--------------
 
756
 
 
757
Some utilities are provided for generating variations of tests.  This can
 
758
be used for per-implementation tests, or other cases where the same test
 
759
code needs to run several times on different scenarios.
 
760
 
 
761
The general approach is to define a class that provides test methods,
 
762
which depend on attributes of the test object being pre-set with the
 
763
values to which the test should be applied.  The test suite should then
 
764
also provide a list of scenarios in which to run the tests.
 
765
 
 
766
Typically ``multiply_tests_from_modules`` should be called from the test
 
767
module's ``load_tests`` function.
 
768
 
 
769
 
 
770
Test support
 
771
------------
 
772
 
 
773
We have a rich collection of tools to support writing tests. Please use
 
774
them in preference to ad-hoc solutions as they provide portability and
 
775
performance benefits.
 
776
 
 
777
 
 
778
TestCase and its subclasses
 
779
~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
780
 
 
781
The ``bzrlib.tests`` module defines many TestCase classes to help you
 
782
write your tests.
 
783
 
 
784
TestCase
 
785
    A base TestCase that extends the Python standard library's
 
786
    TestCase in several ways.  TestCase is build on
 
787
    ``testtools.TestCase``, which gives it support for more assertion
 
788
    methods (e.g.  ``assertContainsRe``), ``addCleanup``, and other
 
789
    features (see its API docs for details).  It also has a ``setUp`` that
 
790
    makes sure that global state like registered hooks and loggers won't
 
791
    interfere with your test.  All tests should use this base class
 
792
    (whether directly or via a subclass).  Note that we are trying not to
 
793
    add more assertions at this point, and instead to build up a library
 
794
    of ``bzrlib.tests.matchers``.
 
795
 
 
796
TestCaseWithMemoryTransport
 
797
    Extends TestCase and adds methods like ``get_transport``,
 
798
    ``make_branch`` and ``make_branch_builder``.  The files created are
 
799
    stored in a MemoryTransport that is discarded at the end of the test.
 
800
    This class is good for tests that need to make branches or use
 
801
    transports, but that don't require storing things on disk.  All tests
 
802
    that create bzrdirs should use this base class (either directly or via
 
803
    a subclass) as it ensures that the test won't accidentally operate on
 
804
    real branches in your filesystem.
 
805
 
 
806
TestCaseInTempDir
 
807
    Extends TestCaseWithMemoryTransport.  For tests that really do need
 
808
    files to be stored on disk, e.g. because a subprocess uses a file, or
 
809
    for testing functionality that accesses the filesystem directly rather
 
810
    than via the Transport layer (such as dirstate).
 
811
 
 
812
TestCaseWithTransport
 
813
    Extends TestCaseInTempDir.  Provides ``get_url`` and
 
814
    ``get_readonly_url`` facilities.  Subclasses can control the
 
815
    transports used by setting ``vfs_transport_factory``,
 
816
    ``transport_server`` and/or ``transport_readonly_server``.
 
817
 
 
818
 
 
819
See the API docs for more details.
 
820
 
 
821
 
 
822
BranchBuilder
 
823
~~~~~~~~~~~~~
 
824
 
 
825
When writing a test for a feature, it is often necessary to set up a
 
826
branch with a certain history.  The ``BranchBuilder`` interface allows the
 
827
creation of test branches in a quick and easy manner.  Here's a sample
 
828
session::
 
829
 
 
830
  builder = self.make_branch_builder('relpath')
 
831
  builder.build_commit()
 
832
  builder.build_commit()
 
833
  builder.build_commit()
 
834
  branch = builder.get_branch()
 
835
 
 
836
``make_branch_builder`` is a method of ``TestCaseWithMemoryTransport``.
 
837
 
 
838
Note that many current tests create test branches by inheriting from
 
839
``TestCaseWithTransport`` and using the ``make_branch_and_tree`` helper to
 
840
give them a ``WorkingTree`` that they can commit to. However, using the
 
841
newer ``make_branch_builder`` helper is preferred, because it can build
 
842
the changes in memory, rather than on disk. Tests that are explictly
 
843
testing how we work with disk objects should, of course, use a real
 
844
``WorkingTree``.
 
845
 
 
846
Please see bzrlib.branchbuilder for more details.
 
847
 
 
848
If you're going to examine the commit timestamps e.g. in a test for log
 
849
output, you should set the timestamp on the tree, rather than using fuzzy
 
850
matches in the test.
 
851
 
 
852
 
 
853
TreeBuilder
 
854
~~~~~~~~~~~
 
855
 
 
856
The ``TreeBuilder`` interface allows the construction of arbitrary trees
 
857
with a declarative interface. A sample session might look like::
 
858
 
 
859
  tree = self.make_branch_and_tree('path')
 
860
  builder = TreeBuilder()
 
861
  builder.start_tree(tree)
 
862
  builder.build(['foo', "bar/", "bar/file"])
 
863
  tree.commit('commit the tree')
 
864
  builder.finish_tree()
 
865
 
 
866
Usually a test will create a tree using ``make_branch_and_memory_tree`` (a
 
867
method of ``TestCaseWithMemoryTransport``) or ``make_branch_and_tree`` (a
 
868
method of ``TestCaseWithTransport``).
 
869
 
 
870
Please see bzrlib.treebuilder for more details.
 
871
 
 
872
 
 
873
.. |--| unicode:: U+2014
 
874
 
 
875
..
 
876
   vim: ft=rst tw=74 ai et sw=4