mirror of
https://github.com/yshui/picom.git
synced 2024-11-11 13:51:02 -05:00
50 lines
788 B
Markdown
50 lines
788 B
Markdown
test.h
|
|
======
|
|
|
|
A very simple, light weight, header only C unit test framework.
|
|
|
|
## Features
|
|
|
|
* Easy to use, no dependencies, no setup needed.
|
|
* Keep test cases close to the code they test.
|
|
* Automatic registration of the test cases.
|
|
|
|
## Setup
|
|
|
|
Just include the header
|
|
|
|
```c
|
|
#include "test.h"
|
|
```
|
|
|
|
To enable the test cases in your code, compile your program with `-DUNIT_TEST`.
|
|
|
|
## Defining test cases
|
|
|
|
```c
|
|
TEST_CASE(test_case_name) {
|
|
// Your code here
|
|
// ...
|
|
TEST_EQUAL(1, 0); // Fail
|
|
}
|
|
```
|
|
|
|
## Run the test cases
|
|
|
|
In your main function, call `run_tests`:
|
|
|
|
```c
|
|
int main(int argc, char *const *argv) {
|
|
// necessary setup code
|
|
// ...
|
|
if (!run_tests(argc, argv)) {
|
|
// test failed
|
|
abort();
|
|
}
|
|
// cleanup
|
|
// usual code
|
|
}
|
|
|
|
```
|
|
|
|
Then, run your program with `./program --unittest`.
|