241
In general tests should be placed in a file named testFOO.py where
251
In general tests should be placed in a file named test_FOO.py where
242
252
FOO is the logical thing under test. That file should be placed in the
243
253
tests subdirectory under the package being tested.
245
For example, tests for merge3 in bzrlib belong in bzrlib/tests/testmerge3.py.
246
See bzrlib/selftest/testsampler.py for a template test script.
255
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
256
See bzrlib/selftest/test_sampler.py for a template test script.
258
Tests can be written for the UI or for individual areas of the library.
259
Choose whichever is appropriate: if adding a new command, or a new command
260
option, then you should be writing a UI test. If you are both adding UI
261
functionality and library functionality, you will want to write tests for
262
both the UI and the core behaviours. We call UI tests 'blackbox' tests
263
and they are found in ``bzrlib/tests/blackbox/*.py``.
265
When writing blackbox tests please honour the following conventions:
267
1. Place the tests for the command 'name' in
268
bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
269
to locate the test script for a faulty command.
271
2. Use the 'self.run_bzr("name")' utility function to invoke the command
272
rather than running bzr in a subprocess or invoking the
273
cmd_object.run() method directly. This is a lot faster than
274
subprocesses and generates the same logging output as running it in a
275
subprocess (which invoking the method directly does not).
277
3. Only test the one command in a single test script. Use the bzrlib
278
library when setting up tests and when evaluating the side-effects of
279
the command. We do this so that the library api has continual pressure
280
on it to be as functional as the command line in a simple manner, and
281
to isolate knock-on effects throughout the blackbox test suite when a
282
command changes it name or signature. Ideally only the tests for a
283
given command are affected when a given command is changed.
288
We make selective use of doctests__. In general they should provide
289
*examples* within the API documentation which can incidentally be tested. We
290
don't try to test every important case using doctests -- regular Python
291
tests are generally a better solution.
293
Most of these are in ``bzrlib/doc/api``. More additions are welcome.
295
__ http://docs.python.org/lib/module-doctest.html
251
300
Currently, bzr selftest is used to invoke tests.
252
301
You can provide a pattern argument to run a subset. For example,
253
to run just the whitebox tests, run::
255
bzr selftest -v whitebox
302
to run just the blackbox tests, run::
304
./bzr selftest -v blackbox
306
To skip a particular test (or set of tests), you need to use a negative
309
./bzr selftest '^(?!.*blackbox)'
258
312
Errors and exceptions
273
327
indexes into the branch's revision history.
333
The ``Transport`` layer handles access to local or remote directories.
334
Each Transport object acts like a logical connection to a particular
335
directory, and it allows various operations on files within it. You can
336
*clone* a transport to get a new Transport connected to a subdirectory or
339
Transports are not used for access to the working tree. At present
340
working trees are always local and they are accessed through the regular
341
Python file io mechanisms.
346
Transports work in URLs. Take note that URLs are by definition only
347
ASCII - the decision of how to encode a Unicode string into a URL must be
348
taken at a higher level, typically in the Store. (Note that Stores also
349
escape filenames which cannot be safely stored on all filesystems, but
350
this is a different level.)
352
The main reason for this is that it's not possible to safely roundtrip a
353
URL into Unicode and then back into the same URL. The URL standard
354
gives a way to represent non-ASCII bytes in ASCII (as %-escapes), but
355
doesn't say how those bytes represent non-ASCII characters. (They're not
356
guaranteed to be UTF-8 -- that is common but doesn't happen everywhere.)
358
For example if the user enters the url ``http://example/%e0`` there's no
359
way to tell whether that character represents "latin small letter a with
360
grave" in iso-8859-1, or "latin small letter r with acute" in iso-8859-2
361
or malformed UTF-8. So we can't convert their URL to Unicode reliably.
363
Equally problematic if we're given a url-like string containing non-ascii
364
characters (such as the accented a) we can't be sure how to convert that
365
to the correct URL, because we don't know what encoding the server expects
366
for those characters. (Although this is not totally reliable we might still
367
accept these and assume they should be put into UTF-8.)
369
A similar edge case is that the url ``http://foo/sweet%2Fsour`` contains
370
one directory component whose name is "sweet/sour". The escaped slash is
371
not a directory separator. If we try to convert URLs to regular Unicode
372
paths this information will be lost.
374
This implies that Transports must natively deal with URLs; for simplicity
375
they *only* deal with URLs and conversion of other strings to URLs is done
376
elsewhere. Information they return, such as from ``list_dir``, is also in
377
the form of URL components.
380
Unicode and Encoding Support
381
============================
383
This section discusses various techniques that Bazaar uses to handle
384
characters that are outside the ASCII set.
389
When a ``Command`` object is created, it is given a member variable
390
accessible by ``self.outf``. This is a file-like object, which is bound to
391
``sys.stdout``, and should be used to write information to the screen,
392
rather than directly writing to ``sys.stdout`` or calling ``print``.
393
This file has the ability to translate Unicode objects into the correct
394
representation, based on the console encoding. Also, the class attribute
395
``encoding_type`` will effect how unprintable characters will be
396
handled. This parameter can take one of 3 values:
399
Unprintable characters will be represented with a suitable replacement
400
marker (typically '?'), and no exception will be raised. This is for
401
any command which generates text for the user to review, rather than
402
for automated processing.
403
For example: ``bzr log`` should not fail if one of the entries has text
404
that cannot be displayed.
407
Attempting to print and unprintable character will cause a UnicodeError.
408
This is for commands that are intended more as scripting support, rather
409
than plain user review.
410
For exampl: ``bzr ls`` is designed to be used with shell scripting. One
411
use would be ``bzr ls --null --unknows | xargs -0 rm``. If ``bzr``
412
printed a filename with a '?', the wrong file could be deleted. (At the
413
very least, the correct file would not be deleted). An error is used to
414
indicate that the requested action could not be performed.
417
Do not attempt to automatically convert Unicode strings. This is used
418
for commands that must handle conversion themselves.
419
For example: ``bzr diff`` needs to translate Unicode paths, but should
420
not change the exact text of the contents of the files.
423
``bzrlib.urlutils.unescape_for_display``
424
----------------------------------------
426
Because Transports work in URLs (as defined earlier), printing the raw URL
427
to the user is usually less than optimal. Characters outside the standard
428
set are printed as escapes, rather than the real character, and local
429
paths would be printed as ``file://`` urls. The function
430
``unescape_for_display`` attempts to unescape a URL, such that anything
431
that cannot be printed in the current encoding stays an escaped URL, but
432
valid characters are generated where possible.
276
435
Merge/review process
277
436
====================
added
removed
HACKING
