test Adding documentation on module test
authorOlle E. Johansson <oej@edvina.net>
Fri, 3 Jun 2016 19:27:26 +0000 (21:27 +0200)
committerOlle E. Johansson <oej@edvina.net>
Fri, 3 Jun 2016 19:27:26 +0000 (21:27 +0200)
At this point this is just ideas and a proposal. Let's test it. Includes ideas on
variant of the abort() function in cfg_utils

test/README.md [new file with mode: 0644]

diff --git a/test/README.md b/test/README.md
new file mode 100644 (file)
index 0000000..0547475
--- /dev/null
@@ -0,0 +1,26 @@
+Test directory
+===============
+
+Modules
+-------
+Note: Under development (2016-06-03 OEJ)
+
+Modules found here test APIs in other modules or are just created for testing, not for production
+use. In order to use the existing build system, each module needs a directory named mod_something
+in test. 
+
+Each module needs a subdirectory called "test" with a test configuration and a Makefile.
+
+A typical test script load the htable module and execute tests in the [event:htable_init]
+event route when starting. Typically, if a test fails, it runs abort() from the cfg_utils
+module to abort the process. 
+
+
+Ideas: We may need a way to exit kamailio from inside without dumping a core file, but simply
+stopping execution and returning different return values to the shell. That way a test
+config can run for a limited amount of time or until a test fails. We can also
+stop on an external action, like a RPC request calling the same function.
+
+Targets:
+       - "test":       Test syntax with "kamailio -c"
+       - "all":        Run full test