0547475bad0747db499007179ed72d3d4d629be4
[sip-router] / test / README.md
1 Test directory
2 ===============
3
4 Modules
5 -------
6 Note: Under development (2016-06-03 OEJ)
7
8 Modules found here test APIs in other modules or are just created for testing, not for production
9 use. In order to use the existing build system, each module needs a directory named mod_something
10 in test. 
11
12 Each module needs a subdirectory called "test" with a test configuration and a Makefile.
13
14 A typical test script load the htable module and execute tests in the [event:htable_init]
15 event route when starting. Typically, if a test fails, it runs abort() from the cfg_utils
16 module to abort the process. 
17
18
19 Ideas: We may need a way to exit kamailio from inside without dumping a core file, but simply
20 stopping execution and returning different return values to the shell. That way a test
21 config can run for a limited amount of time or until a test fails. We can also
22 stop on an external action, like a RPC request calling the same function.
23
24 Targets:
25         - "test":       Test syntax with "kamailio -c"
26         - "all":        Run full test