tctd unit test & debug framework

Unit Testing

The basic architecture of the framework on unit testing is https://cmocka.org, but I always feel that it is complex to use. Therefore, I write the framework and the users needn't any compiling, it's a single header file and a source file. The weakness is the implemention and interface are fused, but plz accord to my document.

The interfaces of unit testing are: Test, tctd_utest, TCTDUTest, tctd_run_utests and assertions.

Test is the protocol for test instance. i.e.

Test testFunc1(){...}
tctd_utest is wrapper of Test function. i.e.

tctd_utest(testFunc1)
Use type TCTDUTest to make test groups.

TCTDUTest testGropu[2] = {tctd_utest(testFunc`), tctd_utest(testFunc2)}
tctd_run_utests is a macro running the test functions. tctd_run_utests(utest)

tctd_run_utest(testGroup)
The assertions use https://nemequ.github.io/munit/#assertions.

Debugging

The modern IDEs (visual studio, eclipse,...) have good debugging tools, but in practice, step through is an important technique for deugging. In the complex code, coders often want to watch the variables value. The debugging offers the convenient temporary variables declaration.

#define TCTD_DEBUG
You can use DEBUG macro in the debuged functions.

DEBUG temp_vars(t, float*, 3) //This will declare 3 float* temp var.: t_1, t_2, t_3
The biggest number is 15.

Utilities

The utilities serve both unit testing, debugging and the users. There are 4 parts:

ouput
memory control
benchmarking
random number generation

Output

A global variables tctd_file is used here. FILE* tctd_file is the logging file used in the output. If define LOGGING, you shoule provide tctd_file to write. And file control is given to the users, open and close. If not define LOGGING, stdout and stderr are used.

Memory control

Wrap the malloc and free which make them safe and friendly. Altogether, tctd can write the log of usage of malloc and free to tctd_file that is checked memory leak.

tctd_malloc(type, size)
tctd_free(ptr)
tctd_malloc_log(type, size)
tctd_free_log(ptr)

These functions also are convenient for memory leak inspection.

Benchmarking

2 types of interfaces are provided: macro and fucntions.

bench B;

TCTD\_INIT\_BENCH(B, 3)

func();

TCTD\_END\_BENCH(B)

TCTD\_SUM\_BENCH(B)

getTime(), bench_start(), bench_stop(), bench_print_summary() also provide interface to users.

Random number generation.

tctd_rand_seed() will set random seed.

tctd_rand_int_range_*() generate integers in different intervals.

tctd_urand() generates uniform distribution in [a,b].

Andy8787/tctd