update test notes
[portage.git] / TEST-NOTES
1 UnitTests
2 ---------
3
4 Portage has some tests that use the unittest framework that ships with python (2.3-2.4ish)
5 Tests have a specific naming convention.
6
7 in pym/portage/tests/ there is a runTest script that invokes pym/portage/tests/__init__.py
8
9 This init looks at a hardcoded list of test dirs to search for tests.
10 If you add a new dir and don't see your new tests, make sure that the dir is in this list.
11
12 On the subject of adding more directories; the layout is basically 1 directory per portage
13 file at this point (we have few files, and even fewer large files).  Inside of the dir
14 you should have files of the form test_${function}.py.
15
16 So if I was to write a vercmp test, and vercmp is in portage_versions.
17
18 pym/portage/tests/portage_versions/test_vercmp.py
19
20 would be the filename.
21
22 The __init__.py file now does recursive tests, but you need to tell it so.  For example, if
23 you had cache tests the dir format would be something like...
24
25 pym/portage/tests/cache/flat_hash/test_foo.py
26
27 and you would put "cache/flat_hash" into the testDirs variable in __init__.py.
28
29 emerge
30 ------
31
32 The emerge namespace currently has 0 tests (and no runner)