/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/testing.txt

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/testing.txt
1
1
====================
2
 
Breezy Testing Guide
 
2
Bazaar Testing Guide
3
3
====================
4
4
 
5
5
 
7
7
=========================
8
8
 
9
9
Reliability is a critical success factor for any version control system.
10
 
We want Breezy to be highly reliable across multiple platforms while
 
10
We want Bazaar to be highly reliable across multiple platforms while
11
11
evolving over time to meet the needs of its community.
12
12
 
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.
26
26
 
27
 
By doing these things, the Breezy team gets increased confidence that
 
27
By doing these things, the Bazaar 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.
32
32
 
33
 
As of September 2009, Breezy ships with a test suite containing over
 
33
As of September 2009, Bazaar 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 Breezy has?
 
36
on your project to a product *without* a test suite like Bazaar has?
37
37
 
38
38
 
39
39
Running the Test Suite
40
40
======================
41
41
 
42
 
As of Breezy 2.1, you must have the testtools_ library installed to run
43
 
the brz test suite.
 
42
As of Bazaar 2.1, you must have the testtools_ library installed to run
 
43
the bzr test suite.
44
44
 
45
45
.. _testtools: https://launchpad.net/testtools/
46
46
 
47
 
To test all of Breezy, just run::
48
 
 
49
 
  brz selftest 
50
 
 
51
 
With ``--verbose`` brz will print the name of every test as it is run.
 
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
52
 
53
53
This should always pass, whether run from a source tree or an installed
54
 
copy of Breezy.  Please investigate and/or report any failures.
 
54
copy of Bazaar.  Please investigate and/or report any failures.
55
55
 
56
56
 
57
57
Running particular tests
58
58
------------------------
59
59
 
60
 
Currently, brz selftest is used to invoke tests.
 
60
Currently, bzr 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::
63
63
 
64
 
  ./brz selftest -v blackbox
 
64
  ./bzr selftest -v blackbox
65
65
 
66
66
To skip a particular test (or set of tests), use the --exclude option
67
67
(shorthand -x) like so::
68
68
 
69
 
  ./brz selftest -v -x blackbox
 
69
  ./bzr selftest -v -x blackbox
70
70
 
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::
74
74
 
75
 
  ./brz selftest --strict
 
75
  ./bzr selftest --strict
76
76
 
77
77
To list tests without running them, use the --list-only option like so::
78
78
 
79
 
  ./brz selftest --list-only
 
79
  ./bzr selftest --list-only
80
80
 
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)::
89
89
 
90
 
  ./brz selftest -- load-list my_failing_tests
 
90
  ./bzr selftest -- load-list my_failing_tests
91
91
 
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
98
98
specified string. It will also avoid loading the other tests and as a
99
99
consequence starts running your tests quicker::
100
100
 
101
 
  ./brz selftest --starting-with breezy.blackbox
 
101
  ./bzr selftest --starting-with bzrlib.blackbox
102
102
 
103
103
This option can be combined with all the other selftest options including
104
104
--load-list. The later is rarely used but allows to run a subset of a list of
107
107
Disabling plugins
108
108
-----------------
109
109
 
110
 
To test only the brz core, ignoring any plugins you may have installed,
 
110
To test only the bzr core, ignoring any plugins you may have installed,
111
111
use::
112
112
 
113
 
  ./brz --no-plugins selftest 
 
113
  ./bzr --no-plugins selftest 
114
114
 
115
115
Disabling crash reporting
116
116
-------------------------
117
117
 
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
 
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
120
least because a test failed if for no other reason.
121
121
 
122
122
Therefore you should probably add ``debug_flags = no_apport`` to your
123
 
``breezy.conf`` file (in ``~/.config/breezy/`` on Unix), so that failures just
 
123
``bazaar.conf`` file (in ``~/.bazaar/`` on Unix), so that failures just
124
124
print a traceback rather than writing a crash file.
125
125
 
126
126
.. _apport: https://launchpad.net/apport/
129
129
Test suite debug flags
130
130
----------------------
131
131
 
132
 
Similar to the global ``-Dfoo`` debug options, brz selftest accepts
 
132
Similar to the global ``-Dfoo`` debug options, bzr selftest accepts
133
133
``-E=foo`` debug flags.  These flags are:
134
134
 
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. ``brz -Dhpss selftest -E=allow_debug``
 
137
  with e.g. ``bzr -Dhpss selftest -E=allow_debug``
138
138
 
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.
143
143
Using subunit
144
144
-------------
145
145
 
146
 
Breezy can optionally produce output in the machine-readable subunit_
 
146
Bazaar 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::
149
149
 
150
 
 $ ./brz selftest --subunit
 
150
 $ ./bzr selftest --subunit
151
151
 
152
152
Processing such a stream can be done using a variety of tools including:
153
153
 
165
165
Using testrepository
166
166
--------------------
167
167
 
168
 
Breezy ships with a config file for testrepository_. This can be very
 
168
Bazaar ships with a config file for testrepository_. This can be very
169
169
useful for keeping track of failing tests and doing general workflow
170
170
support. To run tests using testrepository::
171
171
 
184
184
.. _testrepository: https://launchpad.net/testrepository
185
185
 
186
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
 
187
196
Running tests in parallel
188
197
-------------------------
189
198
 
190
 
Breezy can use subunit to spawn multiple test processes.  There is
 
199
Bazaar can use subunit to spawn multiple test processes.  There is
191
200
slightly more chance you will hit ordering or timing-dependent bugs but
192
201
it's much faster::
193
202
 
194
 
  $ ./brz selftest --parallel=fork
 
203
  $ ./bzr selftest --parallel=fork
195
204
 
196
205
Note that you will need the Subunit library
197
206
<https://launchpad.net/subunit/> to use this, which is in
207
216
 
208
217
  $ sudo mkdir /ram
209
218
  $ sudo mount -t tmpfs none /ram
210
 
  $ TMPDIR=/ram ./brz selftest ...
 
219
  $ TMPDIR=/ram ./bzr selftest ...
211
220
 
212
221
You could also change ``/tmp`` in ``/etc/fstab`` to have type ``tmpfs``,
213
222
if you don't mind possibly losing other files in there when the machine
223
232
=============
224
233
 
225
234
Normally you should add or update a test for all bug fixes or new features
226
 
in Breezy.
 
235
in Bazaar.
227
236
 
228
237
 
229
238
Where should I put a new test?
230
239
------------------------------
231
240
 
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:
 
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:
234
243
 
235
244
 - Unit tests
236
245
 - Blackbox (UI) tests
237
246
 - Per-implementation tests
238
247
 - Doctests
239
248
 
240
 
A quick description of these test types and where they belong in breezy's
 
249
A quick description of these test types and where they belong in bzrlib's
241
250
source follows.  Not all tests fall neatly into one of these categories;
242
251
in those cases use your judgement.
243
252
 
250
259
as possible.  Each unit test is generally fairly short and runs very
251
260
quickly.
252
261
 
253
 
They are found in ``breezy/tests/test_*.py``.  So in general tests should
 
262
They are found in ``bzrlib/tests/test_*.py``.  So in general tests should
254
263
be placed in a file named test_FOO.py where FOO is the logical thing under
255
264
test.
256
265
 
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.
 
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.
259
268
 
260
269
 
261
270
Blackbox (UI) tests
266
275
option, then you should be writing a UI test.  If you are both adding UI
267
276
functionality and library functionality, you will want to write tests for
268
277
both the UI and the core behaviours.  We call UI tests 'blackbox' tests
269
 
and they belong in ``breezy/tests/blackbox/*.py``.
 
278
and they belong in ``bzrlib/tests/blackbox/*.py``.
270
279
 
271
280
When writing blackbox tests please honour the following conventions:
272
281
 
273
282
 1. Place the tests for the command 'name' in
274
 
    breezy/tests/blackbox/test_name.py. This makes it easy for developers
 
283
    bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
275
284
    to locate the test script for a faulty command.
276
285
 
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
 
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
279
288
    cmd_object.run() method directly. This is a lot faster than
280
289
    subprocesses and generates the same logging output as running it in a
281
290
    subprocess (which invoking the method directly does not).
282
291
 
283
 
 3. Only test the one command in a single test script. Use the breezy
 
292
 3. Only test the one command in a single test script. Use the bzrlib
284
293
    library when setting up tests and when evaluating the side-effects of
285
294
    the command. We do this so that the library api has continual pressure
286
295
    on it to be as functional as the command line in a simple manner, and
288
297
    command changes its name or signature. Ideally only the tests for a
289
298
    given command are affected when a given command is changed.
290
299
 
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
 
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
293
302
    process will not load plugins unless ``--allow-plugins`` is supplied.
294
303
 
295
304
 
300
309
against multiple implementations of an interface.  For example,
301
310
``per_transport.py`` defines tests that all Transport implementations
302
311
(local filesystem, HTTP, and so on) must pass. They are found in
303
 
``breezy/tests/per_*/*.py``, and ``breezy/tests/per_*.py``.
 
312
``bzrlib/tests/per_*/*.py``, and ``bzrlib/tests/per_*.py``.
304
313
 
305
314
These are really a sub-category of unit tests, but an important one.
306
315
 
307
316
Along the same lines are tests for extension modules. We generally have
308
317
both a pure-python and a compiled implementation for each module. As such,
309
318
we want to run the same tests against both implementations. These can
310
 
generally be found in ``breezy/tests/*__*.py`` since extension modules are
 
319
generally be found in ``bzrlib/tests/*__*.py`` since extension modules are
311
320
usually prefixed with an underscore. Since there are only two
312
321
implementations, we have a helper function
313
 
``breezy.tests.permute_for_extension``, which can simplify the
 
322
``bzrlib.tests.permute_for_extension``, which can simplify the
314
323
``load_tests`` implementation.
315
324
 
316
325
 
326
335
isolation, you're likely want to write unit tests anyway if only to get a
327
336
better control of the test environment.
328
337
 
329
 
Most of these are in ``breezy/doc/api``.  More additions are welcome.
 
338
Most of these are in ``bzrlib/doc/api``.  More additions are welcome.
330
339
 
331
340
  __ http://docs.python.org/lib/module-doctest.html
332
341
 
333
342
There is an `assertDoctestExampleMatches` method in
334
 
`breezy.tests.TestCase` that allows you to match against doctest-style
 
343
`bzrlib.tests.TestCase` that allows you to match against doctest-style
335
344
string templates (including ``...`` to skip sections) from regular Python
336
345
tests.
337
346
 
339
348
Shell-like tests
340
349
----------------
341
350
 
342
 
``breezy/tests/script.py`` allows users to write tests in a syntax very
 
351
``bzrlib/tests/script.py`` allows users to write tests in a syntax very
343
352
close to a shell session, using a restricted and limited set of commands
344
353
that should be enough to mimic most of the behaviours.
345
354
 
380
389
 
381
390
Examples:
382
391
 
383
 
The following will succeeds only if 'brz add' outputs 'adding file'::
 
392
The following will succeeds only if 'bzr add' outputs 'adding file'::
384
393
 
385
 
  $ brz add file
 
394
  $ bzr add file
386
395
  >adding file
387
396
 
388
397
If you want the command to succeed for any output, just use::
389
398
 
390
 
  $ brz add file
 
399
  $ bzr add file
391
400
  ...
392
401
  2>...
393
402
 
394
403
or use the ``--quiet`` option::
395
404
 
396
 
  $ brz add -q file
 
405
  $ bzr add -q file
397
406
 
398
407
The following will stop with an error::
399
408
 
400
 
  $ brz not-a-command
 
409
  $ bzr not-a-command
401
410
 
402
411
If you want it to succeed, use::
403
412
 
404
 
  $ brz not-a-command
405
 
  2> brz: ERROR: unknown command "not-a-command"
 
413
  $ bzr not-a-command
 
414
  2> bzr: ERROR: unknown command "not-a-command"
406
415
 
407
416
You can use ellipsis (...) to replace any piece of text you don't want to be
408
417
matched exactly::
409
418
 
410
 
  $ brz branch not-a-branch
411
 
  2>brz: ERROR: Not a branch...not-a-branch/".
 
419
  $ bzr branch not-a-branch
 
420
  2>bzr: ERROR: Not a branch...not-a-branch/".
412
421
 
413
422
This can be used to ignore entire lines too::
414
423
 
435
444
 
436
445
You can run files containing shell-like scripts with::
437
446
 
438
 
  $ brz test-script <script>
 
447
  $ bzr test-script <script>
439
448
 
440
449
where ``<script>`` is the path to the file containing the shell-like script.
441
450
 
442
451
The actual use of ScriptRunner within a TestCase looks something like
443
452
this::
444
453
 
445
 
    from breezy.tests import script
 
454
    from bzrlib.tests import script
446
455
 
447
456
    def test_unshelve_keep(self):
448
457
        # some setup here
449
458
        script.run_script(self, '''
450
 
            $ brz add -q file
451
 
            $ brz shelve -q --all -m Foo
452
 
            $ brz shelve --list
 
459
            $ bzr add -q file
 
460
            $ bzr shelve -q --all -m Foo
 
461
            $ bzr shelve --list
453
462
            1: Foo
454
 
            $ brz unshelve -q --keep
455
 
            $ brz shelve --list
 
463
            $ bzr unshelve -q --keep
 
464
            $ bzr shelve --list
456
465
            1: Foo
457
466
            $ cat file
458
467
            contents of file
465
474
        commands.builtin_command_registry.register(cmd_test_confirm)
466
475
        self.addCleanup(commands.builtin_command_registry.remove, 'test-confirm')
467
476
        self.run_script("""
468
 
            $ brz test-confirm
 
477
            $ bzr test-confirm
469
478
            2>Really do it? [y/n]: 
470
479
            <yes
471
480
            yes
477
486
 
478
487
    def test_ignoring_null_output(self):
479
488
        self.run_script("""
480
 
            $ brz init
481
 
            $ brz ci -m 'first revision' --unchanged
482
 
            $ brz log --line
 
489
            $ bzr init
 
490
            $ bzr ci -m 'first revision' --unchanged
 
491
            $ bzr log --line
483
492
            1: ...
484
493
            """, null_output_matches_anything=True)
485
494
           
487
496
Import tariff tests
488
497
-------------------
489
498
 
490
 
`breezy.tests.test_import_tariff` has some tests that measure how many
 
499
`bzrlib.tests.test_import_tariff` has some tests that measure how many
491
500
Python modules are loaded to run some representative commands.
492
501
 
493
502
We want to avoid loading code unnecessarily, for reasons including:
501
510
 
502
511
* Some optional modules such as `testtools` are meant to be soft
503
512
  dependencies and only needed for particular cases.  If they're loaded in
504
 
  other cases then brz may break for people who don't have those modules.
 
513
  other cases then bzr may break for people who don't have those modules.
505
514
  
506
515
`test_import_tariff` allows us to check that removal of imports doesn't
507
516
regress.
516
525
 
517
526
Unless selftest is run with ``--no-plugins``, modules will be loaded in
518
527
the usual way and checks made on what they cause to be loaded.  This is
519
 
probably worth checking into, because many brz users have at least some
 
528
probably worth checking into, because many bzr users have at least some
520
529
plugins installed (and they're included in binary installers).
521
530
 
522
531
In theory, plugins might have a good reason to load almost anything:
523
532
someone might write a plugin that opens a network connection or pops up a
524
 
gui window every time you run 'brz status'.  However, it's more likely
 
533
gui window every time you run 'bzr status'.  However, it's more likely
525
534
that the code to do these things is just being loaded accidentally.  We
526
535
might eventually need to have a way to make exceptions for particular
527
536
plugins.
530
539
 
531
540
* non-GUI commands shouldn't load GUI libraries
532
541
 
533
 
* operations on brz native formats sholudn't load foreign branch libraries
 
542
* operations on bzr native formats sholudn't load foreign branch libraries
534
543
 
535
544
* network code shouldn't be loaded for purely local operations
536
545
 
545
554
a hook that is called when a write lock is: acquired, released or broken.
546
555
(Read locks also exist, they cannot be discovered in this way.)
547
556
 
548
 
A hook can be installed by calling breezy.lock.Lock.hooks.install_named_hook.
 
557
A hook can be installed by calling bzrlib.lock.Lock.hooks.install_named_hook.
549
558
The three valid hooks are: `lock_acquired`, `lock_released` and `lock_broken`.
550
559
 
551
560
Example::
563
572
 
564
573
The last part of the `lock_url` allows you to identify the type of object that is locked.
565
574
 
566
 
- brzDir: `/branch-lock`
 
575
- BzrDir: `/branch-lock`
567
576
- Working tree: `/checkout/lock`
568
577
- Branch: `/branch/lock`
569
578
- Repository: `/repository/lock`
572
581
 
573
582
    self.assertEndsWith(locks_acquired[0].lock_url, "/checkout/lock")
574
583
 
575
 
See breezy/tests/commands/test_revert.py for an example of how to use this for
 
584
See bzrlib/tests/commands/test_revert.py for an example of how to use this for
576
585
testing locks.
577
586
 
578
587
 
588
597
that relating to that.  ::
589
598
 
590
599
    try:
591
 
        return self.branch_format.initialize(repo.brzdir)
 
600
        return self.branch_format.initialize(repo.bzrdir)
592
601
    except errors.UninitializableFormat:
593
602
        raise tests.TestSkipped('Uninitializable branch format')
594
603
 
599
608
Several different cases are distinguished:
600
609
 
601
610
TestSkipped
602
 
        Generic skip; the only type that was present up to brz 0.18.
 
611
        Generic skip; the only type that was present up to bzr 0.18.
603
612
 
604
613
TestNotApplicable
605
614
        The test doesn't apply to the parameters with which it was run.
642
651
like merges to the mainline and releases where we want to make sure that
643
652
everything that can be tested has been tested.  Lax mode is for use by
644
653
developers who want to temporarily tolerate some known failures.  The
645
 
default behaviour is obtained by ``brz selftest`` with no options, and
 
654
default behaviour is obtained by ``bzr selftest`` with no options, and
646
655
also (if possible) by running under another unittest harness.
647
656
 
648
657
======================= ======= ======= ========
686
695
actually instances not classses they're now given instance-style names
687
696
like ``apport``.
688
697
 
689
 
Features already defined in ``breezy.tests`` and ``breezy.tests.features``
 
698
Features already defined in ``bzrlib.tests`` and ``bzrlib.tests.features``
690
699
include:
691
700
 
692
701
 - apport
707
716
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
708
717
 
709
718
New features for use with ``_test_needs_features`` or ``requireFeature``
710
 
are defined by subclassing ``breezy.tests.Feature`` and overriding the
 
719
are defined by subclassing ``bzrlib.tests.Feature`` and overriding the
711
720
``_probe`` and ``feature_name`` methods.  For example::
712
721
 
713
722
    class _SymlinkFeature(Feature):
723
732
A helper for handling running tests based on whether a python
724
733
module is available. This can handle 3rd-party dependencies (is
725
734
``paramiko`` available?) as well as stdlib (``termios``) or
726
 
extension modules (``breezy._groupcompress_pyx``). You create a
 
735
extension modules (``bzrlib._groupcompress_pyx``). You create a
727
736
new feature instance with::
728
737
 
729
 
    # in breezy/tests/features.py
 
738
    # in bzrlib/tests/features.py
730
739
    apport = tests.ModuleAvailableFeature('apport')
731
740
 
732
741
 
733
 
    # then in breezy/tests/test_apport.py
 
742
    # then in bzrlib/tests/test_apport.py
734
743
    class TestApportReporting(TestCaseInTempDir):
735
744
 
736
745
        _test_needs_features = [features.apport]
764
773
Typically patches that apply the ``@deprecated_function`` decorator should
765
774
update the accompanying tests to use the ``applyDeprecated`` wrapper.
766
775
 
767
 
``applyDeprecated`` is defined in ``breezy.tests.TestCase``. See the API
 
776
``applyDeprecated`` is defined in ``bzrlib.tests.TestCase``. See the API
768
777
docs for more details.
769
778
 
770
779
 
788
797
 
789
798
2. Tests that when an api is called in a particular situation, it raises
790
799
   an error of the expected class.  You should typically use
791
 
   ``assertRaises``, which in the Breezy test suite returns the exception
 
800
   ``assertRaises``, which in the Bazaar test suite returns the exception
792
801
   object to allow you to examine its parameters.
793
802
 
794
803
In some cases blackbox tests will also want to check error reporting.  But
820
829
Interface implementation testing and test scenarios
821
830
---------------------------------------------------
822
831
 
823
 
There are several cases in Breezy of multiple implementations of a common
 
832
There are several cases in Bazaar of multiple implementations of a common
824
833
conceptual interface.  ("Conceptual" because it's not necessary for all
825
834
the implementations to share a base class, though they often do.)
826
835
Examples include transports and the working tree, branch and repository
830
839
fulfils the interface requirements.  For example, every Transport should
831
840
support the ``has()`` and ``get()`` and ``clone()`` methods.  We have a
832
841
sub-suite of tests in ``test_transport_implementations``.  (Most
833
 
per-implementation tests are in submodules of ``breezy.tests``, but not
 
842
per-implementation tests are in submodules of ``bzrlib.tests``, but not
834
843
the transport tests at the moment.)
835
844
 
836
845
These tests are repeated for each registered Transport, by generating a
892
901
TestCase and its subclasses
893
902
~~~~~~~~~~~~~~~~~~~~~~~~~~~
894
903
 
895
 
The ``breezy.tests`` module defines many TestCase classes to help you
 
904
The ``bzrlib.tests`` module defines many TestCase classes to help you
896
905
write your tests.
897
906
 
898
907
TestCase
905
914
    interfere with your test.  All tests should use this base class
906
915
    (whether directly or via a subclass).  Note that we are trying not to
907
916
    add more assertions at this point, and instead to build up a library
908
 
    of ``breezy.tests.matchers``.
 
917
    of ``bzrlib.tests.matchers``.
909
918
 
910
919
TestCaseWithMemoryTransport
911
920
    Extends TestCase and adds methods like ``get_transport``,
913
922
    stored in a MemoryTransport that is discarded at the end of the test.
914
923
    This class is good for tests that need to make branches or use
915
924
    transports, but that don't require storing things on disk.  All tests
916
 
    that create brzdirs should use this base class (either directly or via
 
925
    that create bzrdirs should use this base class (either directly or via
917
926
    a subclass) as it ensures that the test won't accidentally operate on
918
927
    real branches in your filesystem.
919
928
 
957
966
testing how we work with disk objects should, of course, use a real
958
967
``WorkingTree``.
959
968
 
960
 
Please see breezy.branchbuilder for more details.
 
969
Please see bzrlib.branchbuilder for more details.
961
970
 
962
971
If you're going to examine the commit timestamps e.g. in a test for log
963
972
output, you should set the timestamp on the tree, rather than using fuzzy
981
990
method of ``TestCaseWithMemoryTransport``) or ``make_branch_and_tree`` (a
982
991
method of ``TestCaseWithTransport``).
983
992
 
984
 
Please see breezy.treebuilder for more details.
 
993
Please see bzrlib.treebuilder for more details.
985
994
 
986
995
PreviewTree
987
996
~~~~~~~~~~~
1048
1057
If yout test needs to temporarily change some environment variable value
1049
1058
(which generally means you want it restored at the end), you can use::
1050
1059
 
1051
 
    self.overrideEnv('brz_ENV_VAR', 'new_value')
 
1060
    self.overrideEnv('BZR_ENV_VAR', 'new_value')
1052
1061
 
1053
1062
If you want to remove a variable from the environment, you should use the
1054
1063
special ``None`` value::
1058
1067
If you add a new feature which depends on a new environment variable, make
1059
1068
sure it behaves properly when this variable is not defined (if applicable) and
1060
1069
if you need to enforce a specific default value, check the
1061
 
``TestCase._cleanEnvironment`` in ``breezy.tests.__init__.py`` which defines a
 
1070
``TestCase._cleanEnvironment`` in ``bzrlib.tests.__init__.py`` which defines a
1062
1071
proper set of values for all tests.
1063
1072
 
1064
1073
Cleaning up
1070
1079
fails, later cleanups are still run.
1071
1080
 
1072
1081
(The same facility is available outside of tests through
1073
 
``breezy.cleanup``.)
 
1082
``bzrlib.cleanup``.)
1074
1083
 
1075
1084
 
1076
1085
Manual testing