README
1testsuite
2
3OVERVIEW
4========
5
6Kmod's testsuite was designed to automate the process of running tests with
7different scenarios, configurations and architectures. The idea is that once we
8received a bug report, we reproduce it using the testsuite so we avoid
9recurring on the same bug in future.
10
11
12FEATURES
13========
14
15- Isolate each test by running them in separate processes;
16- Exec a binary, so we can test the tools and not only the lib API
17- Fake accesses to filesystem so we can provide a test rootfs with all the
18 configuration, indexes, etc that test needs to be executed.
19- Fake calls to init_module(), delete_module() and uname(), so we don't have to
20 run tests as root and figure out how to deal with different architectures.
21
22HOW TO ADD A TEST
23=================
24
25The simplest way to add a test is to copy and paste one already there. Most of
26the options you can have are covered by another tests. This is what you need to
27pay attention when writing a test:
28
291 - Look at testsuite.h, struct test, to see all the options available.
30
312 - Use TESTSUITE_MAIN and DEFINE_TEST to add new tests. Don't forget to fill
32 its description.
33
343 - If you want testsuite to compare the stdout/stderr of your tests in order
35 to check if it worked or not, fill in output.{stderr,stdout} the file with
36 the expected output. Bear in mind the same file is used for all
37 architectures, so don't print arch-dependent content if you are comparing
38 the output.
39
404 - Fill in the config vector. Setting any of these configuration will make
41 testsuite to export LD_PRELOAD with the necessary override libs before
42 executing the test. If you are not exec'ing an external binary, you need to
43 pass "need_spawn = true" below, otherwise it will not work (LD_PRELOAD is
44 only applied when exec'ing a binary). See each config description in
45 testsuite.h
46
475 - need_spawn: if testsuite will exec itself before running a test
48
496 - expected_fail: if that test is expected to fail, i.e. the return code is
50 expected not to be 0.
51
527 - The rootfs is populated by copying the entire contents of rootfs-pristine
53 then running populate-modules.sh to copy generated modules from
54 module-playground. Update the latter script to include any modules your
55 test need.
56
578 - Tests can be run individually, outside of 'make check'. strace and gdb work
58 too, as long as you tell them to operate on child process.
59
609 - Make sure test passes when using "default" build flags, i.e. by running
61 'autogen.sh c'
62